fix: 🐛 update release flow logic | add update version.py

Author: Drew Yang

.github/workflows/docs.yaml

@@ -2,14 +2,9 @@ name: Docs release
 on:
   # manually trigger
   workflow_dispatch:
-  # Once draft release is released, trigger the docs release
-  release:
-    types:
-      ## pre-release and stable release
-      #- published
-      ## stable release only
-      - released
-run-name: "📚 Release docs ${{ github.event.release.tag_name }}"
+  # been called by other workflows
+  workflow_call:
+
 jobs:
   publish-docs:
     runs-on: ubuntu-latest

.github/workflows/post-release.yaml

@@ -0,0 +1,39 @@
+name: Update version.py on Release
+
+on:
+  # Once draft release is released, trigger the docs release
+  release:
+    types:
+      ## pre-release and stable release
+      #- published
+      ## stable release only
+      - released
+
+jobs:
+  update-version:
+    permissions:
+      # write permission is required to update version.py
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Publish docs
+        call-publish-docs:
+        runs-on: ubuntu-latest
+        steps:
+          - uses: ./.github/workflows/docs.yaml
+      - name: Update version.py
+        id: update_version
+        run: |
+          VERSION=$(echo "${{ github.event.release.name }}" | grep -oP '\d+\.\d+\.\d+')
+          echo "VERSION=$VERSION" >> $GITHUB_ENV
+          sed -i "s/^__version__ = .*/__version__ = \"$VERSION\"/" datajoint/version.py
+          # Commit the changes
+          git config --global user.name "github-actions"
+          git config --global user.email "[email protected]"
+          git add datajoint/version.py
+          git commit -m "Update version.py to $VERSION"
+          git push

.github/workflows/release.yaml

@@ -32,6 +32,15 @@ jobs:
       TWINE_TEST_PASSWORD: ${{secrets.twine_test_password}}
       TESTPYPI: ${{ github.event.inputs.testpypi }}
     steps:
+      # Drafts your next Release notes as Pull Requests are merged into "master"
+      - name: Draft release notes
+        id: create_gh_release
+        uses: release-drafter/release-drafter@v6
+        with:
+          config-name: release_drafter.yaml
+          disable-autolabeler: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - uses: actions/checkout@v4
       - name: Set up Python ${{matrix.py_ver}}
         uses: actions/setup-python@v5
@@ -47,7 +56,7 @@ jobs:
           python -m build .
           echo "DJ_WHEEL_PATH=$(ls dist/datajoint-*.whl)" >> $GITHUB_ENV
           echo "DJ_SDIST_PATH=$(ls dist/datajoint-*.tar.gz)" >> $GITHUB_ENV
-          echo "NEW_VERSION=$(grep -oP '\d+\.\d+\.\d+' datajoint/version.py)" >> $GITHUB_ENV
+          echo "NEW_VERSION=${{steps.create_gh_release.outputs.resolved_version}}" >> $GITHUB_ENV
       - name: Publish package
         run: |
           export HOST_UID=$(id -u)
@@ -68,18 +77,8 @@ jobs:
             -e TWINE_REPOSITORY=${TWINE_REPOSITORY} \
             app sh -c "pip install twine && python -m twine upload dist/*"
           else
-            echo "::warning::The latest version $LATEST_PYPI on $TWINE_REPOSITORY is the new version $NEW_VERSION"
+            echo "::warning::Latest version $LATEST_PYPI on $TWINE_REPOSITORY is the new version $NEW_VERSION"
           fi
-      # Drafts your next Release notes as Pull Requests are merged into "master"
-      - name: Draft release notes
-        id: create_gh_release
-        uses: release-drafter/release-drafter@v6
-        if: ${{ github.event.inputs.testpypi == 'false' }}
-        with:
-          config-name: release_drafter.yaml
-          disable-autolabeler: true
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       # Upload package as release assets
       - name: Upload pip wheel asset to release
         if: ${{ github.event.inputs.testpypi == 'false' }}

datajoint/version.py

@@ -1,3 +1,6 @@
+# version bump auto managed by Github Actions:
+# label_prs.yaml(prep), release.yaml(bump), post_release.yaml(edit)
+# manually set this version will be eventaully overwriten by the above actions
 __version__ = "0.14.4"
 
 assert len(__version__) <= 10  # The log table limits version to the 10 characters