Create a GH action to prepare a new release (#744)

* Create namespace updater script

* Set up workflow logic

* Update constant values

* Add new changelog heading

* Update workflow

* Adjust commands

* Job name

* Install ruby & sass

* Specify Ruby version

* Try installing Sass with npm

* Setup WP CLI

* Try disabling xdebug

* Set upstream to

* Just set upstream

* Try passing in as variable

* Env£

* Validate branch doesn't exist & add GH token

* Tweak branch validation logic

* Remove branch validation for now

* Include body

* New validation logic

* Adjust logic again!

* Remove unnecessary permission

* Make the PR a draft

* Remove unnecessary colon

Co-authored-by: Drew Jaynes <[email protected]>

---------

Co-authored-by: Drew Jaynes <[email protected]>

Author: agibson-godaddy

.github/scripts/update-namespace.sh

@@ -0,0 +1,57 @@
+#!/bin/bash
+set -Eeuo pipefail
+
+SCRIPT_DIR="$(cd "$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")" && pwd)"
+if ! command -v jq >/dev/null; then
+	echo "Please install jq"
+	exit 1
+fi
+
+COMPOSER_FILE="${SCRIPT_DIR}/../../composer.json"
+
+OLD_VERSION=$(jq -e -r .version "${COMPOSER_FILE}")
+echo "Old version: ${OLD_VERSION}"
+echo "New version: ${NEW_VERSION}"
+
+# replace `.` with `_` to build our namespace string
+OLD_VERSION_WITH_UNDERSCORES=${OLD_VERSION//./_}
+OLD_NAMESPACE_STRING="v${OLD_VERSION_WITH_UNDERSCORES}"
+
+NEW_VERSION_WITH_UNDERSCORES=${NEW_VERSION//./_}
+NEW_NAMESPACE_STRING="v${NEW_VERSION_WITH_UNDERSCORES}"
+
+# replace version in `composer.json`
+echo "Updating composer.json version"
+UPDATED_JSON="$(jq --arg NEW_VERSION "${NEW_VERSION}" '.version = $NEW_VERSION' "${COMPOSER_FILE}")"
+
+# replace autoload namespaces in `composer.json`
+echo "Updating autoload namespaces in composer.json"
+AUTOLOAD_PSR4="$(echo "${UPDATED_JSON}" | jq -e '.autoload["psr-4"]')"
+AUTOLOAD_PSR4="$(echo "${AUTOLOAD_PSR4}" | sed "s/${OLD_NAMESPACE_STRING}/${NEW_NAMESPACE_STRING}/g")"
+
+AUTOLOAD_DEV_PSR4="$(echo "${UPDATED_JSON}" | jq -e '.["autoload-dev"]["psr-4"]')"
+AUTOLOAD_DEV_PSR4="$(echo "${AUTOLOAD_DEV_PSR4}" | sed "s/${OLD_NAMESPACE_STRING}/${NEW_NAMESPACE_STRING}/g")"
+
+UPDATED_JSON="$(echo "${UPDATED_JSON}" | jq --argjson AUTOLOAD_PSR4 "${AUTOLOAD_PSR4}" --argjson AUTOLOAD_DEV_PSR4 "${AUTOLOAD_DEV_PSR4}" '.autoload["psr-4"] = $AUTOLOAD_PSR4 | .["autoload-dev"]["psr-4"] = $AUTOLOAD_DEV_PSR4')"
+echo "${UPDATED_JSON}" > "${COMPOSER_FILE}"
+
+# replace namespace in `./woocommerce/` directory; we're looking in PHP and JS files only
+echo "Replacing instances of ${OLD_NAMESPACE_STRING} with ${NEW_NAMESPACE_STRING} in ./woocommerce/"
+find "${SCRIPT_DIR}/../../woocommerce/" -type f \( -name '*.php' -o -name '*.js' \) -exec sed -i "s/${OLD_NAMESPACE_STRING}/${NEW_NAMESPACE_STRING}/g" {} \;
+
+# replace namespace in `./tests/` directory
+echo "Replacing instances of ${OLD_NAMESPACE_STRING} with ${NEW_NAMESPACE_STRING} in ./tests/"
+find "${SCRIPT_DIR}/../../tests/" -type f -name '*.php' -exec sed -i "s/${OLD_NAMESPACE_STRING}/${NEW_NAMESPACE_STRING}/g" {} \;
+
+# replace version number in `./woocommerce/class-sv-wc-plugin.php` file
+echo "Replacing VERSION constant value in ./woocommerce/class-sv-wc-plugin.php file"
+sed -i -e "s/public const VERSION = '${OLD_VERSION}';/public const VERSION = '${NEW_VERSION}';/g" "${SCRIPT_DIR}/../../woocommerce/class-sv-wc-plugin.php"
+
+# replace version number in `./woocommerce-framework-plugin-loader-sample.php` file
+echo "Replacing FRAMEWORK_VERSION constant value in ./woocommerce-framework-plugin-loader-sample.php file"
+sed -i -e "s/public const FRAMEWORK_VERSION = '${OLD_VERSION}';/public const FRAMEWORK_VERSION = '${NEW_VERSION}';/g" "${SCRIPT_DIR}/../../woocommerce-framework-plugin-loader-sample.php"
+
+# add new changelog heading on line 3
+echo "Adding changelog heading for new version"
+CHANGELOG_HEADING="$(date +%Y).nn.nn - version ${NEW_VERSION}\n"
+sed -i "3i ${CHANGELOG_HEADING}" "${SCRIPT_DIR}/../../woocommerce/changelog.txt"

.github/workflows/prep-release.yml

@@ -2,3 +2,79 @@ name: Prepare Release
 
 on:
   workflow_dispatch:
+    inputs:
+      new-version:
+        type: string
+        description: "New version number"
+        required: true
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  prepare-release:
+    name: Prepare Release v${{ inputs.new-version }}
+    runs-on: ubuntu-latest
+    env:
+      NEW_VERSION: ${{ inputs.new-version }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Validate release branch
+        run: |
+          BRANCH="release/${NEW_VERSION}"
+          BRANCH_EXISTS=$(git ls-remote --heads origin $BRANCH | wc -l)
+
+          if [[ $BRANCH_EXISTS == '1' ]]; then
+            echo The release/"${NEW_VERSION}" branch already exists. Please delete it to proceed.
+            exit 1
+          else
+            echo The release/"${NEW_VERSION}" branch does not exist... proceeding!
+          fi
+
+      - name: Create new release branch
+        run: git checkout -b release/"${NEW_VERSION}"
+
+      - name: Replace namespaces and versions through entire codebase
+        run: ./.github/scripts/update-namespace.sh
+
+      - name: Install Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+
+      - name: Install sass
+        run: npm install -g sass
+
+      # We disable Xdebug because when enabled it makes the WP pot generation fail :shrug:
+      - name: Disable Xdebug
+        run: sudo phpdismod xdebug
+
+      - name: Setup WP-CLI
+        uses: godaddy-wordpress/setup-wp-cli@1
+
+      - name: Install packages
+        run: npm install
+
+      - name: Bump package.json version
+        run: npm version --no-git-tag-version --allow-same-version "${NEW_VERSION}"
+
+      - name: Build assets
+        run: npm run build
+
+      - name: Commit
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add .
+          git commit -m "Version ${NEW_VERSION}"
+          git push --set-upstream origin release/"${NEW_VERSION}"
+
+      - name: Create pull request
+        run: |
+          gh pr create -B "${BASE_BRANCH}" -H release/"${NEW_VERSION}" --title "Release v${NEW_VERSION}" --body "Release v${NEW_VERSION}" --draft
+        env:
+          BASE_BRANCH: ${{ github.ref_name }}
+          GH_TOKEN: ${{ github.token }}