build: update release workflow to create PR with release changes

Author: BryanttV

.github/workflows/release.yml .github/workflows/create-release-pr.yml.github/workflows/release.yml renamed to .github/workflows/create-release-pr.yml

@@ -1,9 +1,9 @@
-name: Create a new GitHub Release
+name: Create a Release Pull Request
 
 on:
   workflow_dispatch:
     inputs:
-      tag:
+      bump-type:
         description: "The type of version bump"
         required: true
         type: choice
@@ -13,10 +13,10 @@ on:
           - "patch"
 
 jobs:
-  release:
+  create-release-pr:
     runs-on: ubuntu-latest
     env:
-      TAG: ${{ github.event.inputs.tag }}
+      BUMP_TYPE: ${{ github.event.inputs.bump-type }}
 
     steps:
       - name: Checkout
@@ -27,37 +27,35 @@ jobs:
         with:
           python-version: 3.11
 
-      - name: Install requirements
+      - name: Install release requirements
         run: pip install scriv bump-my-version
 
-      - name: Install pandoc for scriv
-        run: sudo apt install -y pandoc
-
-      - name: Set up Git
+      - name: Configure Git user
         run: |
           git config user.name 'github-actions[bot]'
           git config user.email 'github-actions[bot]@users.noreply.github.com'
 
-      - name: Get current and new version
+      - name: Compute version bump
         id: version
         run: |
           echo "CURRENT_VERSION=$(bump-my-version show current_version)" >> $GITHUB_OUTPUT
-          echo "NEW_VERSION=$(bump-my-version show --increment $TAG new_version)" >> $GITHUB_OUTPUT
+          echo "NEW_VERSION=$(bump-my-version show --increment $BUMP_TYPE new_version)" >> $GITHUB_OUTPUT
 
       - name: Bump version
-        run: bump-my-version bump $TAG
+        run: bump-my-version bump $BUMP_TYPE
 
       - name: Collect changelog
         run: make changelog
 
-      - name: Commit changes and create tag
-        uses: stefanzweifel/git-auto-commit-action@v5
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v7
         with:
-          branch: ${{ github.ref }}
-          commit_message: "chore: bump version ${{ steps.version.outputs.CURRENT_VERSION }} → ${{ steps.version.outputs.NEW_VERSION }}"
-          tagging_message: "v${{ steps.version.outputs.NEW_VERSION }}"
-
-      - name: Create GitHub release
-        run: scriv github-release --repo=openedx/openedx-events
-        env:
-          GITHUB_TOKEN: ${{ github.token }}
+          commit-message: "chore: bump version ${{ steps.version.outputs.CURRENT_VERSION }} → ${{ steps.version.outputs.NEW_VERSION }}"
+          title: "v${{ steps.version.outputs.NEW_VERSION }} Release"
+          body: |
+            ### Description
+
+            This PR bumps the version from `${{ steps.version.outputs.CURRENT_VERSION }}` to `${{ steps.version.outputs.NEW_VERSION }}`.
+
+            The changelog has been automatically generated using `scriv`.
+          branch: "release-${{ steps.version.outputs.NEW_VERSION }}"

.github/workflows/github-release.yml

@@ -0,0 +1,45 @@
+name: Create a new GitHub Release
+
+on:
+  workflow_dispatch:
+
+jobs:
+  github-release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - name: Install release requirements
+        run: pip install scriv bump-my-version
+
+      - name: Install pandoc for scriv
+        run: sudo apt install -y pandoc
+
+      - name: Configure Git user
+        run: |
+          git config user.name 'github-actions[bot]'
+          git config user.email 'github-actions[bot]@users.noreply.github.com'
+
+      - name: Read current version
+        id: version
+        run: |
+          echo "CURRENT_VERSION=$(bump-my-version show current_version)" >> $GITHUB_OUTPUT
+
+      - name: Create and push Git tag
+        env:
+          CURRENT_VERSION: ${{ steps.version.outputs.CURRENT_VERSION }}
+        run: |
+          git tag -a "v$CURRENT_VERSION" -m "Release v$CURRENT_VERSION"
+          git push origin "v$CURRENT_VERSION"
+
+      - name: Create GitHub release
+        run: scriv github-release --repo=openedx/openedx-events
+        env:
+          GITHUB_TOKEN: ${{ github.token }}