Merge pull request #560 from plotly/github-actions-auto-release

Add automation to automatically release zipped apps

Former-commit-id: ce31166

Author: Xing Han Lu

.github/workflows/main.yml

@@ -0,0 +1,44 @@
+# https://github.com/actions/upload-release-asset/issues/28#issuecomment-617208601
+on:
+  push:
+    branches:
+      - master
+
+name: Release and upload apps
+
+jobs:
+  build:
+    name: Upload Release Asset
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: '0'
+      - name: Bump version and push tag
+        id: version_bump
+        uses: anothrNick/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          WITH_V: true
+      - name: Compress apps
+        run: |
+          cd ./apps;
+          for f in */; do
+            echo "Zipping ${f}...";
+            zip -qr "${f%/*}" "${f}"*;
+          done
+          cd -;
+      - name: Create release and upload zipped apps
+        run: |
+          cd ./apps;
+          set -x
+          assets=()
+          for asset in ./*.zip; do
+            assets+=("-a" "$asset")
+          done
+          hub release create "${assets[@]}" -m "Release ${RELEASE_TAG}" "${RELEASE_TAG}"
+          cd -;
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          RELEASE_TAG: ${{ steps.version_bump.outputs.new_tag }}

README.md

@@ -3,7 +3,7 @@
 This is a monorepo designed to host all of the apps that have been
 created for the Python Dash Gallery.
 
-## Running an example app
+## Running an example app after cloning the repo
 
 You will need to run applications, and specify filenames, from the
 root directory of the repository. e.g., if the name of the app you
@@ -14,6 +14,21 @@ of the repository.
 Each app has a requirements.txt, install the dependecies in a virtual
 environment.
 
+## Downloading and running a single app
+
+Visit the [releases page](https://github.com/plotly/dash-sample-apps/releases) and download and `unzip` the app you want. Then `cd` into the app directory and install its dependencies in a virtual environment in the following way:
+
+```bash
+python -m venv venv
+source venv/bin/activate  # Windows: \venv\scripts\activate
+pip install -r requirements.txt
+```
+
+then run the app:
+```bash
+python app.py
+```
+
 ## Contributing to the sample apps repo
 
 _"DDS app" below refers to the deployed application. For example, if