Automate

Author: spoorcc

.github/workflows/build.yml

@@ -13,6 +13,7 @@ permissions:
 jobs:
 
   build:
+    needs: prepare-release
     strategy:
       matrix:
         platform: [ubuntu-latest, macos-latest, windows-latest]

.github/workflows/python-publish.yml

@@ -17,6 +17,7 @@ permissions:
 
 jobs:
   build:
+    needs: prepare-release
     name: Build distribution 📦
     runs-on: ubuntu-latest
 

.github/workflows/release.yml

@@ -4,61 +4,58 @@ on:
   push:
     branches:
       - main
+      - automate-release
     tags:
-      - 'v*.*.*'
+      - '*.*.*'
+
+permissions:
+  contents: read
 
 jobs:
-  release:
+  prepare-release:
     runs-on: ubuntu-latest
-    needs: build_artifacts  # previous jobs that create artifacts
+    permissions:
+      contents: write
+      security-events: write
+
     steps:
-      - name: Checkout
-        uses: actions/checkout@v3
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v5.0.0
 
-      - name: Set up Python
-        uses: actions/setup-python@v4
+      - name: Setup Python
+        uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0
         with:
-          python-version: "3.x"
+          python-version: '3.13'
 
       - name: Determine release info
         id: release_info
         run: |
           if [[ "${GITHUB_REF}" == "refs/heads/main" ]]; then
             TAG="latest"
-            RELEASE_NAME="Latest Release"
-            LATEST_FLAG="--latest"
           else
             TAG="${GITHUB_REF#refs/tags/}"
-            RELEASE_NAME="Release $TAG"
-            LATEST_FLAG=""
           fi
           echo "tag=$TAG" >> $GITHUB_OUTPUT
-          echo "release_name=$RELEASE_NAME" >> $GITHUB_OUTPUT
-          echo "latest_flag=$LATEST_FLAG" >> $GITHUB_OUTPUT
 
       - name: Update latest tag
-        if: github.ref == 'refs/heads/main'
-        uses: EndBug/latest-tag@v9
+        if: github.ref == 'refs/heads/automate-release'
+        uses: EndBug/latest-tag@52ce15b2695f86a4ce47b72387dee54e47f6356c # v1.6.2
         with:
-          tag-name: latest
+          ref: latest
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Generate release notes
         id: notes
         run: |
-          notes=$(python create_release_notes.py ${{ steps.release_info.outputs.latest_flag }})
-          echo "release_notes<<EOF" >> $GITHUB_OUTPUT
-          echo "$notes" >> $GITHUB_OUTPUT
-          echo "EOF" >> $GITHUB_OUTPUT
+          python script/create_release_notes.py
 
-      - name: Create/update latest release
-        if: github.ref == 'refs/heads/main'
+      - name: Create release
         uses: softprops/action-gh-release@v1
         with:
           tag_name: ${{ steps.release_info.outputs.tag }}
-          name: ${{ steps.release_info.outputs.release_name }}
-          body: ${{ steps.notes.outputs.release_notes }}
+          name: ${{ steps.release_info.outputs.tag }}
+          body_text: release_notes.txt
           draft: true
+          overwrite: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -13,3 +13,4 @@ doc/landing-page/_build
 example/Tests/
 venv*
 *.cdx.json
+release_notes.txt

script/create_release_notes.py

@@ -59,7 +59,9 @@ def main():
         return
 
     release_notes = extract_latest_section(changelog_path)
-    print(release_notes)
+
+    with open("release_notes.txt", "w", encoding="UTF-8") as notes:
+        print(release_notes, file=notes)
 
 
 if __name__ == "__main__":