Merge pull request #453 from facultyai/docs-release

Update docs requirements after release

Author: tcbegley

.github/workflows/build-docs.yml

@@ -9,6 +9,9 @@ on:
       - examples/**
       - .github/workflows/build-docs.yml
       - .github/actions/push_docs/**
+  release:
+    types:
+      - released
 
 jobs:
   build_docs:

.github/workflows/release.yml

@@ -28,6 +28,8 @@ jobs:
           python-version: 3.8
       - name: Install Python dependencies
         run: python -m pip install dash[dev] flit invoke semver termcolor
+      - name: Update docs requirements
+        run: invoke set-documentation-version ${{ steps.get-version.outputs.version }}
       - uses: JS-DevTools/npm-publish@v1
         with:
           token: ${{ secrets.NPM_TOKEN }}
@@ -36,13 +38,13 @@ jobs:
         env:
           FLIT_USERNAME: ${{ secrets.FLIT_USERNAME }}
           FLIT_PASSWORD: ${{ secrets.FLIT_PASSWORD }}
-      - name: Commit updated package-lock.json
+      - name: Commit updated package-lock.json and docs requirements
         uses: stefanzweifel/git-auto-commit-action@v4
         with:
           commit_message: Release ${{ steps.get-version.outputs.version }}
           branch: master
           push_options: --force
-          file_pattern: package-lock.json
+          file_pattern: package-lock.json docs/requirements.txt
       - name: Create GitHub release
         id: create-release
         uses: actions/create-release@v1

tasks.py

@@ -56,12 +56,10 @@ def release(ctx, version):
     """
     info(f"Creating release branch for {version}")
     set_source_version(version)
-    set_documentation_version(version)
 
     run(f"git checkout -b release/{version}")
     run(
         "git add package.json package-lock.json "
-        "docs/requirements.txt "
         "dash_bootstrap_components/__init__.py "
         "tests/test_version.py"
     )
@@ -146,7 +144,8 @@ def set_js_version(version):
         f.writelines(package_json)
 
 
-def set_documentation_version(version):
+@task
+def set_documentation_version(ctx, version):
     version = normalize_version(version)
     docs_requirements_path = HERE / "docs" / "requirements.txt"
     with docs_requirements_path.open() as f: