Merge release/5.1.0 into trunk

Author: alefesouza

.github/actions/generate-changelog/action.yml renamed to .github/actions/process-changelog/action.yml

@@ -1,5 +1,5 @@
-name: "Generate the changelog for WooCommerce Payments"
-description: "Generate the changelog from the version provided"
+name: "Process the changelog for WooCommerce Payments"
+description: "Generate or amend the changelog entries"
 
 inputs:
   release-version:
@@ -9,29 +9,41 @@ inputs:
     description: "The release date (format: YYYY-MM-DD) for which the action should generate the changelog (default: unreleased)"
     required: false
     default: "unreleased"
+  action-type:
+    description: 'Whether this is to generate or amend the changelog entries (generate or amend)'
+    required: false
+    default: "generate"
 
 outputs: 
   changelog:
-    description: "The escaped changelog content generated from the release version provided"
-    value: ${{ steps.get_changelog.outputs.CHANGELOG }}
+    description: "The escaped changelog content"
+    value: ${{ steps.process_changelog.outputs.CHANGELOG }}
 
 runs:
   using: composite
   steps:
-    - name: "Generate changelog"
-      id: get_changelog
+    - name: "Process changelog"
+      id: process_changelog
       shell: bash
       env:
-        VERSION: ${{ inputs.release-version }}
+        ACTION_TYPE: ${{ inputs.action-type }}
+        RELEASE_VERSION: ${{ inputs.release-version }}
         RELEASE_DATE: ${{ inputs.release-date }}
       run: |
         # Install this dev package globally to gather changelog entries while not including it into the release package
         composer global require automattic/jetpack-changelogger:^3.0.7
         
-        # Gather changelog entries
-        ~/.composer/vendor/bin/changelogger write --use-version="$VERSION" --release-date="$RELEASE_DATE"
+        if ${{ env.ACTION_TYPE == 'generate' }}; then
+          CHANGELOG_FLAG=""
+          echo "Generating the changelog entries." >> $GITHUB_STEP_SUMMARY
+        else
+          CHANGELOG_FLAG="--amend"
+          echo "Amending the changelog entries." >> $GITHUB_STEP_SUMMARY
+        fi
+          
+        ~/.composer/vendor/bin/changelogger write --use-version="$RELEASE_VERSION" --release-date="$RELEASE_DATE" $CHANGELOG_FLAG --no-interaction
         
-        echo "Picking up changelog for version '$VERSION'..."
+        echo "Picking up changelog for version '$RELEASE_VERSION'..."
         CHANGELOG=$(awk '/^= / { if (p) { exit }; p=1; next } p && NF' changelog.txt)
         echo "$CHANGELOG"
         

.github/workflows/build-zip-file.yml

@@ -1,19 +1,12 @@
 name: "Build zip file"
 
-# This action will run when a pull request targeting `trunk` is closed/merged or when it is triggered manually.
+# This action will run when it is triggered manually.
 on:
-  pull_request_target:
-    branches:
-      - 'trunk'
-    types:
-      - closed
   workflow_dispatch:
 
 jobs:
-  # The job runs only if the workflow was triggered manually or if it was triggered by a PR targeting trunk which was merged
   build-zip:
     name: "Build the zip file"
-    if: ${{ github.event_name != 'pull_request_target' || startsWith(github.head_ref, 'release/') && github.event.pull_request.merged == true }}
     runs-on: ubuntu-20.04
     steps:
       - name: "Checkout repository"
@@ -25,12 +18,17 @@ jobs:
       - name: "Build the plugin"
         id: build_plugin
         uses: ./.github/actions/build
+
+      - name: "Unzip the file (prevents double zip issue)"
+        run: |
+          echo ":information_source: Unzipping to a folder to prevent double-zip issue ([known limitation](https://github.com/actions/upload-artifact#zipped-artifact-downloads)). Increase in artifact size is expected since we're uploading the folder." >> $GITHUB_STEP_SUMMARY
+          unzip ${{ steps.build_plugin.outputs.release-filename }} -d zipfile
       
       - name: "Upload the zip file as an artifact"
         uses: actions/upload-artifact@v3
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           name: "woocommerce-payments"
-          path: ${{ steps.build_plugin.outputs.release-filename }}
+          path: zipfile
           retention-days: 7

.github/workflows/compatibility.yml

@@ -4,8 +4,8 @@ on:
   pull_request
 
 env:
-  WC_L2_VERSION: '6.8.2'
-  WP_L2_VERSION: '5.8'
+  WC_L2_VERSION: '6.9.0'
+  WP_L2_VERSION: '5.9'
 
 jobs:
   generate-matrix:

.github/workflows/create-pre-release.yml

@@ -43,7 +43,7 @@ jobs:
 
       - name: "Generate the changelog"
         id: generate_changelog
-        uses: ./.github/actions/generate-changelog
+        uses: ./.github/actions/process-changelog
         with:
           release-version: ${{ steps.create_tag.outputs.trimmed-version }}
 

.github/workflows/e2e-test.yml

@@ -23,7 +23,7 @@ env:
   E2E_SLACK_TOKEN:       ${{ secrets.E2E_SLACK_TOKEN }}
   E2E_USE_LOCAL_SERVER:  false
   E2E_RESULT_FILEPATH:   'tests/e2e/results.json'
-  WC_L2_VERSION: '6.8.2'
+  WC_L2_VERSION: '6.9.0'
 
 
 jobs:

.github/workflows/php-lint-test.yml

@@ -5,7 +5,7 @@ on:
 
 env:
   WP_VERSION:        latest
-  WC_L2_VERSION: '6.8.2'  # the min supported version as per L-2 policy
+  WC_L2_VERSION: '6.9.0'  # the min supported version as per L-2 policy
   GUTENBERG_VERSION: latest
 
 jobs:

.github/workflows/platform-checkout-test-site-sync.yml

@@ -3,12 +3,6 @@ name: "Handle post-release steps"
 # This action will run when it is triggered manually
 on:
   workflow_dispatch:
-    inputs:
-      allowMerge:
-        description: 'Whether we allow merging trunk back into develop'
-        required: false
-        type: string
-        default: "false"
 
 defaults:
   run:
@@ -81,7 +75,6 @@ jobs:
   merge-trunk-into-develop:
     name: "Merge trunk back into develop"
     needs: get-last-released-version
-    if: ${{ inputs.allowMerge == 'true' }}
     runs-on: ubuntu-20.04
     env:
       RELEASE_VERSION: ${{ needs.get-last-released-version.outputs.releaseVersion }}
@@ -92,11 +85,12 @@ jobs:
         with:
           ref: 'trunk'
           fetch-depth: 0
+          token: ${{ SECRETS.BOTWOO_TOKEN }}
 
       - name: "Merge trunk back into develop"
         run: |
-          git config user.name "${{ github.actor }}"
-          git config user.email "${{ github.actor }}@users.noreply.github.com"
+          git config user.name "botwoo"
+          git config user.email "botwoo@users.noreply.github.com"
           git checkout develop && git pull
           git merge trunk --no-ff -m "Merge trunk v$RELEASE_VERSION into develop"
           git push

.github/workflows/post-release-updates.yml

@@ -0,0 +1,75 @@
+name: "Release - Changelog"
+
+# This action will run when it is triggered manually
+on:
+  workflow_dispatch:
+    inputs:
+      release-version:
+        description: "The release version for which the action should process the changelog (e.g. 4.5.0)"
+        required: true
+        type: string
+      release-date:
+        description: "The release date in human-readable format (default: 'today')."
+        required: false
+        default: "today"
+        type: string
+      action-type:
+        description: "Whether this is to amend or generate the changelog entries (default: 'amend')."
+        required: true
+        default: "amend"
+        type: choice
+        options:
+          - amend
+          - generate
+
+defaults:
+  run:
+    shell: bash
+
+jobs:    
+  process-changelog:
+    name: "Process the changelog"
+    runs-on: ubuntu-20.04
+    env:
+      CHANGELOG_ACTION: ${{ inputs.action-type }}
+      RELEASE_VERSION: ${{ inputs.release-version }}
+      RELEASE_DATE: ${{ inputs.release-date }}
+    steps:
+      - name: "Checkout repository"
+        uses: actions/checkout@v3
+        
+      - name: "Format the release date"
+        id: format_date
+        run: |
+          RELEASE_DATE=$( date "+%Y-%m-%d" -d "$RELEASE_DATE" ) # Release date formatted as YYYY-MM-DD
+          echo "RELEASE_DATE=$RELEASE_DATE" >> $GITHUB_OUTPUT
+      
+      - name: "Process changelog"
+        id: process_changelog
+        uses: ./.github/actions/process-changelog
+        with:
+          release-version: ${{ env.RELEASE_VERSION }}
+          release-date: ${{ steps.format_date.outputs.RELEASE_DATE }}
+          action-type: ${{ env.CHANGELOG_ACTION }}
+        
+      - name: "Update readme.txt"
+        env:
+          RELEASE_DATE: ${{ steps.format_date.outputs.RELEASE_DATE }}
+          CHANGELOG: ${{ steps.process_changelog.outputs.changelog }}
+        run: |
+          if ${{ env.CHANGELOG_ACTION == 'amend' }}; then
+            perl -i -p0e "s/= $RELEASE_VERSION.*?(\n){2}//s" readme.txt # Delete the existing changelog for the release version
+          fi
+            
+          sed -ri "s|(== Changelog ==)|\1\n\n= $RELEASE_VERSION - $RELEASE_DATE =\n$CHANGELOG|" readme.txt
+                    
+      - name: "Commit and push the changes"
+        run: |
+          git config user.name "${{ github.actor }}"
+          git config user.email "${{ github.actor }}@users.noreply.github.com"
+          if ${{ env.CHANGELOG_ACTION == 'amend' }}; then
+            git commit -am "Amend changelog entries for release $RELEASE_VERSION"
+          else
+            git commit -am "Generate changelog entries for release $RELEASE_VERSION"
+          fi
+          git push

.github/workflows/release-changelog.yml

@@ -9,7 +9,7 @@ on:
         required: true
         type: string
       releaseDateString:
-        description: "The release date in human-readable format, which will be formatted for changelog.txt and readme.txt (default: 'next wednesday')."
+        description: "The release date in human-readable format (default: 'next wednesday')."
         required: false
         default: "next wednesday"
         type: string
@@ -20,7 +20,7 @@ on:
         required: true
         type: string
       releaseDateString:
-        description: "The release date in human-readable format, which will be formatted for changelog.txt and readme.txt (default: 'next wednesday')."
+        description: "The release date in human-readable format (default: 'next wednesday')."
         required: false
         default: "next wednesday"
         type: string
@@ -61,7 +61,7 @@ jobs:
 
       - name: "Generate the changelog"
         id: generate_changelog
-        uses: ./.github/actions/generate-changelog
+        uses: ./.github/actions/process-changelog
         with:
           release-version: ${{ steps.create_branch.outputs.trimmed-version }}
           release-date: ${{ steps.define_var.outputs.RELEASE_DATE }}