Merge pull request #738 from newfold-labs/update/release-prep-workflow

Update release prep workflow

Author: circlecube

.github/scripts/set-version-bump.js

@@ -4,36 +4,30 @@ on:
   workflow_dispatch:
     inputs:
       level:
-        description: The level of release to be used.
+        description: 'The level of release to be used.'
         type: choice
         options:
-          - patch
-          - minor
-          - major
+          - 'patch'
+          - 'minor'
+          - 'major'
         default: 'patch'
         required: true
+# Disable permissions for all available scopes by default.
+# Any needed permissions should be configured at the job level.
+permissions: {}
 
 jobs:
 
-  # This job is used to extract the branch name from the pull request or branch.
-  setup:
-    name: Setup
-    runs-on: ubuntu-latest
-    outputs:
-      branch: ${{ steps.extract_branch.outputs.branch }}
-    steps:
-      - name: Extract branch name
-        shell: bash
-        run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT
-        id: extract_branch
-
   # This job runs the newfold module-prep-release workflow for this module.
   prep-release:
     name: Prepare Release
-    needs: setup
-    uses: newfold-labs/workflows/.github/workflows/module-prep-release.yml@add/preprelease
+    permissions:
+      contents: write
+      pull-requests: write
+    uses: newfold-labs/workflows/.github/workflows/reusable-module-prep-release.yml@main
     with:
       module-repo: ${{ github.repository }}
-      module-branch: ${{ needs.setup.outputs.branch }}
+      module-branch: 'trunk'
       level: ${{ inputs.level }}
-    secrets: inherit
+      json-file: 'package.json'
+      php-file: 'bootstrap.php'

.github/workflows/newfold-prep-release.yml

@@ -77,7 +77,10 @@ The Onboarding module is designed to streamline various tasks related to user on
 - Generate screenshots tailored to the user's preferences and create a child theme using the provided name.
 
 ## Release Process
-### Local Release Preparation
+
+Run the `Newfold Prepare Release` github action to automatically bump the version (either patch, minor or major version), and update build and language files all at once. It will create a PR with changed files for review. Using this workflow, we can skip all the manual steps below.
+
+### Manual Release Preparation
 
 1. **Checkout the trunk branch locally:**
    ```bash
@@ -89,25 +92,28 @@ The Onboarding module is designed to streamline various tasks related to user on
    git pull origin trunk
    ```
 
+3. **Create release branch, where [x.y.z] is the new version (following Semantic Versioning):**
+   ```bash
+   git branch release/[x.y.z]
+   ```
+
 3. **Test for any breaking changes and highlight concerns:**
    - **Conduct thorough testing to ensure stability and functionality.**
    - Note any issues or concerns for further action.
 
 4. **Increment Version via script**
-   - run `npm run set-version-bump`
-      - This will update the version number in required files, remove the old build, and create a fresh build.
-   - Alternatively, update versions and rebuild manually:
-      1. **Increment version following Semantic Versioning 2.0.0:**
+   - Update versions and rebuild manually:
+      1. **Increment version [x.y.z]**
          - Update version in:
          - `bootstrap.php`
          - `package.json`
-         - `package-lock.json`
          - Run:
          ```bash
          npm install
          npm run build
          ```
          - Verify existence of `build/<new_version>` folder.
+         - Remove previous release build files: `build/<old_version>` folder.
          - Update language files. Run: `composer run i18n`.
 
 5. **Push changes to origin:**