Add a release action

.circleci/config.yml

@@ -6,12 +6,12 @@ version: 2.1
 # Orbs are reusable packages of CircleCI configuration that you may share across projects.
 # See: https://circleci.com/docs/2.1/orb-intro/
 orbs:
-  python: circleci/python@1.5.0
+  python: circleci/python@2.1.1
 jobs:
   build-docs:
     docker:
       # A list of available CircleCI Docker convenience images are available here: https://circleci.com/developer/images/image/cimg/python
-      - image: cimg/python:3.10.13
+      - image: cimg/python:3.10
     steps:
       - checkout:
           path: docs

.github/workflows/build_and_deploy.yml

@@ -69,11 +69,23 @@ jobs:
           python -c 'import napari.layers; print(napari.layers.__doc__)'
 
       - name: Create fallback videos
+        # Only needed for deployment, so should **NOT** be in
+        # napari/napari/.github/workflows/build_docs.yml
         run: |
           sudo apt-get update && sudo apt-get install -y ffmpeg
           cd docs
           make fallback-videos
 
+      - name: Update version switcher (on new release)
+        if: ((github.event_name == 'release' && !contains(github.event.release.tag_name, 'rc')) || (github.event_name == 'workflow_dispatch' && github.event.inputs.target_directory != 'dev'))
+        run: |
+          cd docs
+          python docs/_scripts/update_switcher.py ${{ github.event.inputs.target_directory || github.event.release.tag_name }}
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
+          git add docs/_static/version_switcher.json
+          git commit -m "Update version switcher for release" --allow-empty
+
       - name: Build Docs
         uses: aganders3/headless-gui@v2
         env:
@@ -109,13 +121,55 @@ jobs:
           # Downloads to '/home/runner/work/docs/docs/html'
           path: html
 
-      - name: Deploy Docs
+      - name: Deploy Dev Docs
         if: (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && (startsWith(github.ref, 'refs/tags/v') || startsWith(github.ref, 'refs/heads/main'))
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
+          # Note that GITHUB_TOKEN has no permission to access to external repositories.
+          # When you use deploy_key, set your private key to the repository which
+          # includes this action as a secret, and set your public key to your external repository.
           deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
           external_repository: napari/napari.github.io
           publish_dir: ./html
           publish_branch: gh-pages
           destination_dir: ${{ github.event.inputs.target_directory || 'dev' }}
           cname: napari.org
+          keep_files: true
+
+      # Because we are using two deploy actions, we need to reset the ssh-agent
+      # to avoid the following error:
+      # unix_listener: cannot bind to path /tmp/ssh-auth.sock: Address already in use
+      # See https://github.com/peaceiris/actions-gh-pages/issues/909
+      - name: Reset ssh agent
+        if: ((github.event_name == 'release' && !contains(github.event.release.tag_name, 'rc')) || (github.event_name == 'workflow_dispatch' && github.event.inputs.target_directory != 'dev'))
+        run: killall ssh-agent
+
+      # Because the actions-gh-pages triggers a pages deployment, it can be some
+      # time before the repo is updated. We need to wait for the deployment to
+      # complete before we can create a second deployment, or we will have a git
+      # conflict. The 5m sleep is completely arbitrary.
+      - name: Wait for first deployment
+        if: ((github.event_name == 'release' && !contains(github.event.release.tag_name, 'rc')) || (github.event_name == 'workflow_dispatch' && github.event.inputs.target_directory != 'dev'))
+        run: sleep 5m
+
+      - name: Deploy Release Docs
+        if: ((github.event_name == 'release' && !contains(github.event.release.tag_name, 'rc')) || (github.event_name == 'workflow_dispatch' && github.event.inputs.target_directory != 'dev'))
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          external_repository: napari/napari.github.io
+          publish_dir: ./html
+          publish_branch: gh-pages
+          destination_dir: ${{ github.event.inputs.target_directory || github.event.release.tag_name }}
+          cname: napari.org
+          keep_files: true
+
+      - name: Set up stable symlink
+        if: ((github.event_name == 'release' && !contains(github.event.release.tag_name, 'rc')) || (github.event_name == 'workflow_dispatch' && github.event.inputs.target_directory != 'dev'))
+        uses: convictional/[email protected]
+        with:
+          owner: napari
+          repo: napari.github.io
+          github_token: ${{ secrets.WORKFLOW_PAT }}
+          workflow_file_name: symlink-stable.yml
+          client_payload: '{"target_directory": "${{ github.event.inputs.target_directory || github.event.release.tag_name }}"}'

.github/workflows/labeler.yml

@@ -10,6 +10,6 @@ jobs:
       pull-requests: write
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/labeler@v4
+    - uses: actions/labeler@v5
       with:
         repo-token: "${{ secrets.GITHUB_TOKEN }}"

docs/_scripts/update_switcher.py

@@ -0,0 +1,34 @@
+import sys
+import json
+
+
+def update_version_switcher(new_version):
+    """Update version_switcher.json after a new release."""
+    with open("docs/_static/version_switcher.json", "r") as f:
+        switcher = json.load(f)
+    oldstable = switcher[1]
+
+    newstable = oldstable.copy()
+    newstable["version"] = new_version
+    newstable["name"] = f"stable ({new_version})"
+
+    oldstable["name"] = f"{oldstable['version']}"
+    del oldstable["preferred"]
+    oldstable["url"] = oldstable["url"].replace("stable", oldstable["version"])
+
+    switcher[1] = oldstable
+    switcher.insert(1, newstable)
+    with open("docs/_static/version_switcher.json", "w") as f:
+        json.dump(switcher, f, indent=4)
+
+    print(f"Version switcher updated to {new_version}")
+    print(f"Old stable version: {switcher[2]}")
+    print(f"New stable version: {switcher[1]}")
+
+
+if __name__ == "__main__":
+    if len(sys.argv) != 2:
+        print("Usage: python update_switcher.py <new_version>")
+        sys.exit()
+    new_version = sys.argv[1]
+    update_version_switcher(new_version)