feat: ✨ release flow is ready

Drew Yang · Drew Yang · commit e7c10f8ab814 · 2025-03-24T06:10:37.000-05:00
diff --git a/.github/pr_labeler.yaml b/.github/pr_labeler.yaml
@@ -1,8 +1,10 @@
 # https://github.com/actions/labeler
+breaking:
+- head-branch: ['breaking', 'BREAKING']
 bug:
 - head-branch: ['fix', 'FIX', 'bug', 'BUG']
-enhancement:
-- head-branch: ['feat', 'FEAT', 'enhance', 'improve', 'IMPR', 'DJEP']
+feature:
+- head-branch: ['feat', 'FEAT']
 documentation:
 - changed-files:
   - any-glob-to-any-file:
@@ -12,6 +14,8 @@ documentation:
     - CHANGELOG.md
     - CONTRIBUTING.md
 enhancement:
+- head-branch: ['enhance', 'improve', 'IMPR', 'DJEP']
+enhancement:
 - changed-files:
   - any-glob-to-any-file:
     - '**'
diff --git a/.github/release_drafter.yaml b/.github/release_drafter.yaml
@@ -0,0 +1,35 @@
+version-resolver:
+  major:
+    labels:
+      - 'breaking'
+  minor:
+    labels:
+      - 'feature'
+  patch:
+    labels:
+      - 'documentation'
+      - 'enhancement'
+      - 'bug'
+name-template: 'Release $RESOLVED_VERSION'
+tag-template: 'v$RESOLVED_VERSION'
+categories:
+  - title: '💥 Breaking Changes'
+    labels:
+      - 'breaking'
+  - title: '🚀 Features'
+    labels:
+      - 'feature'
+  - title: '⚡️ Enhancements'
+    labels:
+      - 'enhancement'
+  - title: '🐛 Bug Fixes'
+    labels:
+      - 'bug'
+  - title: '📝 Documentation'
+    label: 'documentation'
+change-template: '- $TITLE(#$NUMBER)@$AUTHOR'
+change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
+template: |
+  $CHANGES
+
+  **Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -1,7 +1,14 @@
-name: Manual docs release
+name: Docs release
 on:
+  # manually trigger
   workflow_dispatch:
-  workflow_call:
+  # Once draft release is released, trigger the docs release
+  release:
+    types:
+      ## pre-release and stable release
+      #- published
+      ## stable release only
+      - released
 jobs:
   publish-docs:
     runs-on: ubuntu-latest
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -11,6 +11,12 @@ on:
           - 'false'
 jobs:
   build-release:
+    permissions:
+      # write permission is required to create a github release
+      contents: write
+      # write permission is required for autolabeler
+      # otherwise, read permission is required at least
+      pull-requests: read
     runs-on: ubuntu-latest
     # Use the oldest supported version to build, just in case there are issues
     # for our case, this doesn't matter that much, since the build is for 3.x
@@ -35,11 +41,13 @@ jobs:
       # since datajoint-python doesn't have platform specific dependencies or binaries,
       # and the build process is fairly fast, so removed upload/download artifacts
       - name: Build package
+        id: build
         run: |
           python -m pip install build
           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 "DJ_VERSION=$(grep -oP '\d+\.\d+\.\d+' datajoint/version.py)" >> $GITHUB_OUTPUT
       - name: Publish package
         run: |
           export HOST_UID=$(id -u)
@@ -55,48 +63,16 @@ jobs:
             -e TWINE_PASSWORD=${TWINE_PASSWORD} \
             -e TWINE_REPOSITORY=${TWINE_REPOSITORY} \
             app sh -c "pip install twine && python -m twine upload dist/*"
-      - name: Login to DockerHub
+      # 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' }}
-        uses: docker/login-action@v3
         with:
-          username: ${{secrets.docker_username}}
-          password: ${{secrets.docker_password}}
-      - name: Publish image
-        if: ${{ github.event.inputs.testpypi == 'false' }}
-        run: |
-          IMAGE=$(docker images --filter "reference=datajoint/datajoint*" --format "{{.Repository}}")
-          TAG=$(docker images --filter "reference=datajoint/datajoint*" --format "{{.Tag}}")
-          docker push "${IMAGE}:${TAG}"
-          docker tag "${IMAGE}:${TAG}" "${IMAGE}:${TAG}-${GITHUB_SHA:0:7}"
-          docker push "${IMAGE}:${TAG}-${GITHUB_SHA:0:7}"
-          [ "$PY_VER" == "3.9" ] && [ "$DISTRO" == "debian" ] \
-                  && docker tag "${IMAGE}:${TAG}" "${IMAGE}:latest" \
-                  && docker push "${IMAGE}:latest" \
-              || echo "skipping 'latest' tag..."
-      # Make sure all above release targets are done first, then make a GH release
-      - name: Make release notes
-        if: ${{ github.event.inputs.testpypi == 'false' }}
-        run: |
-          DJ_VERSION=$(grep -oP '\d+\.\d+\.\d+' datajoint/version.py)
-          RELEASE_BODY=$(python -c \
-            'print(open("./CHANGELOG.md").read().split("\n\n")[1].split("\n", 1)[1])' \
-          )
-          echo "DJ_VERSION=${DJ_VERSION}" >> $GITHUB_ENV
-          echo "RELEASE_BODY<<EOF" >> $GITHUB_ENV
-          echo "$RELEASE_BODY" >> $GITHUB_ENV
-          echo "EOF" >> $GITHUB_ENV
-      - name: Create GH release
-        if: ${{ github.event.inputs.testpypi == 'false' }}
-        id: create_gh_release
-        uses: actions/create-release@v1
+          config-name: release_drafter.yaml
+          disable-autolabeler: true
         env:
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
-        with:
-          tag_name: ${{env.DJ_VERSION}}
-          release_name: Release ${{env.DJ_VERSION}}
-          body: ${{env.RELEASE_BODY}}
-          prerelease: false
-          draft: false
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       # Upload package as release assets
       - name: Upload pip wheel asset to release
         if: ${{ github.event.inputs.testpypi == 'false' }}
@@ -118,10 +94,3 @@ jobs:
           asset_path: ${{env.DJ_SDIST_PATH}}
           asset_name: pip-datajoint-${{env.DJ_VERSION}}.tar.gz
           asset_content_type: application/gzip
-  # only release docs when a release is published
-  call-publish-docs:
-    if: ${{ github.event.inputs.testpypi == 'false' }}
-    needs: build-release
-    runs-on: ubuntu-latest
-    steps:
-      - uses: ./.github/workflows/docs.yaml
diff --git a/.github/workflows/tag_latest.yaml b/.github/workflows/tag_latest.yaml
@@ -0,0 +1,16 @@
+name: Tag latest
+on:
+  # Once draft release is released, trigger the docs release
+  release:
+    types:
+      ## stable release only
+      - released
+jobs:
+  tag-latest:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Tag latest
+        run: |
+          git tag -f latest
+          git push origin latest
