Merge pull request #224 from bitpay/manual-release-workflow

Manual release workflow

Author: bobbrodie

.github/workflows/release.yml

@@ -6,86 +6,117 @@ on:
       bump:
         description: 'Version bump type'
         required: true
-        default: 'patch'
         type: choice
         options:
           - patch
           - minor
           - major
       overview:
-        description: 'Overview for the release notes (optional)'
-        required: false
-        type: string
+        description: 'Release overview (will be placed at top of notes)'
+        required: true
 
 jobs:
   release:
-    name: Create Release
+    name: Create tag and release
     runs-on: ubuntu-latest
-    env:
-      NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    outputs:
+      version: ${{ steps.version.outputs.version }}
 
     steps:
-      - name: Checkout repo
+      - name: Checkout target branch
         uses: actions/checkout@v4
         with:
-          fetch-depth: 0
+          ref: ${{ github.ref_name }}
 
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: '20'
+
+      - name: Install dependencies
+        run: npm ci
 
-      - name: Configure git
+      - name: Push version bump and tag
+        id: version
         run: |
           git config user.name "github-actions"
           git config user.email "[email protected]"
+          npm version ${{ github.event.inputs.bump }} --no-git-tag-version
+          version=$(jq -r .version package.json)
+          echo "version=$version" >> $GITHUB_OUTPUT
+          git add package.json package-lock.json
+          git commit -m "Bump version to $version"
+          git tag $version
+          git push origin ${{ github.ref_name }}
+          git push origin $version
 
-      - name: Fetch tags
-        run: git fetch --tags
-
-      - name: Bump version
+      - name: Get merged PR titles and format release notes
+        id: changelog
         run: |
-          NEW_VERSION=$(npm version ${{ github.event.inputs.bump }} --no-git-tag-version)
-          echo "VERSION=${NEW_VERSION}" >> $GITHUB_ENV
+          git fetch --tags
 
-      - name: Commit and tag version bump
-        run: |
-          git commit -am "Bump version to ${VERSION}"
-          git tag ${VERSION}
-          git push origin HEAD
-          git push origin ${VERSION}
+          # Get most recent and previous tags
+          tags=($(git tag --sort=-creatordate))
+          new_tag="${tags[0]}"
+          prev_tag="${tags[1]}"
 
-      - name: Get previous tag
-        id: previous_tag
-        run: |
-          PREV_TAG=$(git tag --sort=-creatordate | grep -v ${VERSION} | head -n 1)
-          echo "PREV_TAG=$PREV_TAG" >> $GITHUB_ENV
-          echo "prev_tag=$PREV_TAG" >> $GITHUB_OUTPUT
+          if [ -z "$prev_tag" ]; then
+            echo "Warning: No previous tag found. Skipping full changelog link."
+            changelog=""
+          else
+            changelog="**Full Changelog**: https://github.com/${{ github.repository }}/compare/$prev_tag...$new_tag"
+          fi
+
+          prs=$(gh pr list --state merged --base "${{ github.ref_name }}" --json title,mergedAt --jq '[.[] | select(.mergedAt != null) | .title]')
+          joined=$(echo "$prs" | jq -r '.[]' | sed 's/^/* /')
 
-      - name: Generate release notes from merged PRs
-        id: release_notes
-        run: |
-          OVERVIEW="${{ github.event.inputs.overview }}"
-          NOTES=$(git log ${{ env.PREV_TAG }}..HEAD --pretty=format:"* %s" --merges)
-          echo -e "${OVERVIEW}\n\n## What's Changed\n${NOTES}\n\n**Full Changelog**: https://github.com/${{ github.repository }}/compare/${{ env.PREV_TAG }}...${{ env.VERSION }}" > release-notes.md
-          cat release-notes.md
           echo "RELEASE_NOTES<<EOF" >> $GITHUB_ENV
-          cat release-notes.md >> $GITHUB_ENV
+          echo "${{ github.event.inputs.overview }}" >> $GITHUB_ENV
+          echo "" >> $GITHUB_ENV
+          echo "## What's Changed" >> $GITHUB_ENV
+          echo "$joined" >> $GITHUB_ENV
+          echo "" >> $GITHUB_ENV
+          echo "$changelog" >> $GITHUB_ENV
           echo "EOF" >> $GITHUB_ENV
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Create GitHub Release
+      - name: Create GitHub release
         run: |
-          gh release create "${VERSION}" \
-            --title "${VERSION}" \
-            --notes "$(cat release-notes.md)"
+          gh release create "${{ steps.version.outputs.version }}" \
+            --title "${{ steps.version.outputs.version }}" \
+            --notes "${{ env.RELEASE_NOTES }}"
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  readme-changelog:
+    name: Publish changelog to Readme
+    needs: release
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Extract release data
+        id: release_data
+        run: |
+          echo "title=${{ needs.release.outputs.version }}" >> $GITHUB_OUTPUT
+          body=$(gh release view ${{ needs.release.outputs.version }} --json body --jq .body)
+          {
+            echo "body<<EOF"
+            echo "$body"
+            echo "EOF"
+          } >> $GITHUB_OUTPUT
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Publish changelog to Readme
         env:
           README_API_KEY: ${{ secrets.README_API_KEY }}
         run: |
-          jq -n --arg title "Node.js Unified SDK v${VERSION}" \
-                --arg body "$(<release-notes.md)" \
+          jq -n --arg title "Node.js Unified SDK v${{ steps.release_data.outputs.title }}" \
+                --arg body "${{ steps.release_data.outputs.body }}" \
                 '{
                   title: $title,
                   content: {
@@ -97,4 +128,4 @@ jobs:
           curl --location 'https://api.readme.com/v2/changelogs' \
             --header "Authorization: Bearer $README_API_KEY" \
             --header 'Content-Type: application/json' \
-            --data @payload.json
+            --data @payload.json