Use API to generate changelog for PECL package

Author: alcaeus

.github/workflows/commit-and-tag.sh

@@ -3,7 +3,6 @@ set -e
 
 PACKAGE_VERSION=$1
 GPG_KEY_ID=$2
-TAG_MESSAGE_FILE=$3
 
 gpgloader
 
@@ -13,4 +12,4 @@ git commit -m "Package ${PACKAGE_VERSION}" -s --gpg-sign=${GPG_KEY_ID} phongo_ve
 
 # Create signed "Release x.y.z" tag
 echo "Create release tag"
-git tag -F ${TAG_MESSAGE_FILE} -s --local-user=${GPG_KEY_ID} ${PACKAGE_VERSION}
+git tag -m "Release ${PACKAGE_VERSION}" -s --local-user=${GPG_KEY_ID} ${PACKAGE_VERSION}

.github/workflows/package-release.yml

@@ -16,6 +16,7 @@ jobs:
     runs-on: "ubuntu-latest"
     permissions:
       id-token: write
+      contents: write
 
     steps:
       - name: "Generate token and checkout repository"
@@ -39,7 +40,13 @@ jobs:
           version: "8.3"
 
       - name: "Write changelog file for packaging"
-        run: git tag -l ${{ github.ref_name }} --format='%(contents)' > changelog
+        run: |
+          gh api \
+            --method POST \
+            -H "Accept: application/vnd.github+json" \
+            -H "X-GitHub-Api-Version: 2022-11-28" \
+            /repos/${{ github.repository }}/releases/generate-notes \
+            -f "tag_name=${{ inputs.ref }}" --jq '.body' > changelog
 
       # This will fill in the release notes from the previously generated changelog
       - name: "Build package.xml"

.github/workflows/release.yml

@@ -93,26 +93,13 @@ jobs:
       # Preliminary checks done - commence the release process
       #
 
-      # Create a draft release with a changelog
-      # TODO: Consider using the API to generate changelog
-      - name: "Create draft release with generated changelog"
-        run: gh release create ${{ env.PACKAGE_VERSION }} --target ${{ github.ref_name }} --generate-notes --draft
-
-      - name: "Read changelog from draft release"
-        run: gh release view ${{ env.PACKAGE_VERSION }} --json body --template '{{ .body }}' >> changelog
-
-      - name: "Prepare tag message"
-        run: |
-          echo -e "Release ${PACKAGE_VERSION}\n" > tag-message
-          cat changelog >> tag-message
-
       # This step creates the "Package x.y.z" commit that will be the base of
       # our tag and creates the release tag. This is run inside the container in
       # order to create signed git artifacts
       - name: "Create package commit and release tag"
         uses: mongodb-labs/drivers-github-tools/git-sign@v2
         with:
-          command: "$(pwd)/.github/workflows/commit-and-tag.sh ${{ env.PACKAGE_VERSION }} ${{ env.GPG_KEY_ID }} tag-message"
+          command: "$(pwd)/.github/workflows/commit-and-tag.sh ${{ inputs.version }} ${{ env.GPG_KEY_ID }}"
 
       # This step needs to happen outside of the container, as PHP is not
       # available within.
@@ -138,16 +125,14 @@ jobs:
       - name: "Prepare release message"
         run: |
           cat > release-message <<'EOL'
-          ${{ format(env.default-release-message, env.PACKAGE_VERSION, inputs.jira-version-number) }}
+          ${{ format(env.default-release-message, inputs.version, inputs.jira-version-number) }}
           EOL
-          cat changelog >> release-message
 
-      # Update release with correct release information
-      - name: "Update release information"
-        run: echo "RELEASE_URL=$(gh release edit ${{ env.PACKAGE_VERSION }} --title "${{ env.PACKAGE_VERSION }}" --notes-file release-message)" >> "$GITHUB_ENV"
+      - name: "Create draft release"
+        run: echo "RELEASE_URL=$(gh release create ${{ inputs.version }} --target ${{ github.ref_name }} --title "${{ inputs.version }}" --notes-file release-message --draft)" >> "$GITHUB_ENV"
 
       - name: "Push release tag"
-        run: git push origin ${{ env.PACKAGE_VERSION }}
+        run: git push origin ${{ inputs.version }}
 
       - name: "Set summary"
         run: |
@@ -173,6 +158,7 @@ jobs:
     secrets: inherit
     permissions:
       id-token: write
+      contents: write
 
   publish-ssdlc-assets:
     needs: