Create and deploy Streamlit apps using Snowflake CLI¶

Prerequisites¶

Before deploying a Streamlit app by using Snowflake CLI and a GitHub Actions workflow, ensure that you:

• Meet the required prerequisites for using Streamlit in Snowflake.

• Have a GitHub repository to add files to.

Example: Create a GitHub Actions workflow using Snowflake CLI¶

To create a GitHub Actions workflow using Snowflake CLI:

1. In your repository, create a main.yml workflow file in the .github/workflows directory.

2. Create a SNOWCLI_PW secret to use in the GitHub Actions workflow.

3. Copy the following into the main.yml file:

   # Name the GitHub Action
   name: Deploy via Snowflake CLI
   
   on:
   push:
       branches:
       - main
   
   env:
   PYTHON_VERSION: '3.8'
   
   jobs:
   build-and-deploy:
       runs-on: ubuntu-latest
       environment: dev
       steps:
       # Checks out your repository under $GITHUB_WORKSPACE, so your workflow can access it
       - name: 'Checkout GitHub Action'
       uses: actions/checkout@v3
   
       - name: Install Python
       uses: actions/setup-python@v4
       with:
           python-version: ${{ env.PYTHON_VERSION }}
   
       - name: 'Install Snowflake CLI'
       shell: bash
       run: |
           python -m pip install --upgrade pip
           pip install snowflake-cli-labs
   
       - name: 'Create config'
       shell: bash
       env:
           SNOWFLAKE_PASSWORD: ${{ secrets.SNOWCLI_PW }}
       run: |
           mkdir -p ~/.snowflake
           cp config.toml ~/.snowflake/config.toml
           echo "password = \"$SNOWFLAKE_PASSWORD\"" >> ~/.snowflake/config.toml
           chmod 0600 ~/.snowflake/config.toml
   
       - name: 'Deploy the Streamlit app'
       shell: bash
       run: |
           snow streamlit deploy --replace
   

   Copy

4. To run your workflow, commit and push the changes to your repository.

For more information, see GitHub Actions documentation.