Merge pull request #12 from NiharR27/develop

Merge develop into master for release 2.0.0

Author: NiharR27

.github/workflows/draft-new-release.yml .github/workflows/Release-1-initiate-new-release.yml

@@ -1,61 +1,58 @@
-name: "Draft new release"
+name: "Release 1 - Initial New Release"
 
 on:
   workflow_dispatch:
     inputs:
       version:
         description: "The version you want to release."
         required: true
+        default: "1.0.0"
 
 jobs:
   draft-new-release:
     name: "Draft a new release"
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Create release branch
         run: git checkout -b release/${{ github.event.inputs.version }}
 
-      # In order to make a commit, we need to initialize a user.
-      # You may choose to write something less generic here if you want, it doesn't matter functionality wise.
       - name: Initialize mandatory git config
         run: |
           git config user.name "GitHub actions"
           git config user.email noreply@github.com
 
-      # This step will differ depending on your project setup
-      # Fortunately, yarn has a built-in command for doing this!
       - name: Bump version in package.json
         run: yarn version --new-version ${{ github.event.inputs.version }} --no-git-tag-version
 
       - name: Commit manifest files
         id: make-commit
         run: |
           git add .
-          git commit --message "Prepare release ${{ github.event.inputs.version }}"
-
-          echo "::set-output name=commit::$(git rev-parse HEAD)"
+          git commit --message "Bump version to ${{ github.event.inputs.version }}"
 
       - name: Push new branch
         run: git push origin release/${{ github.event.inputs.version }}
 
       - name: Create pull request
-        uses: thomaseizinger/create-pull-request@1.0.0
+        uses: thomaseizinger/create-pull-request@1.4.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           head: release/${{ github.event.inputs.version }}
-          base: master
+          base: develop
           title: Release version ${{ github.event.inputs.version }}
-          reviewers: ${{ github.actor }} # By default, we request a review from the person who triggered the workflow.
-          # Write a nice message to the user.
-          # We are claiming things here based on the `publish-new-release.yml` workflow.
-          # You should obviously adopt it to say the truth depending on your release workflow :)
+          reviewers: ${{ github.actor }} #Assign the PR to the user who triggered the release
+          # team-reviewers: |
+          #   developers
+          #   qa-team
           body: |
             Hi @${{ github.actor }}!
 
             This PR was created in response to a manual trigger of the release workflow here: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}.
-            I've updated the changelog and bumped the versions in the manifest files in this commit: ${{ steps.make-commit.outputs.commit }}.
+            I've bumped the versions in the manifest files in this commit: ${{ steps.make-commit.outputs.commit }}.
 
             Merging this PR will create a GitHub release and upload any assets that are created as part of the release build.
+
+            Happy merging!

.github/workflows/Release-2-Merge-develop-to-master.yml

@@ -0,0 +1,41 @@
+name: "Release 2 - Create PR to merge develop into master"
+
+on:
+  pull_request:
+    branches:
+      - develop
+    types:
+      - closed
+
+jobs:
+  create-develop-to-master-pr:
+    name: "Create PR to merge develop into master"
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.merged == true &&
+      startsWith(github.event.pull_request.head.ref, 'release/')
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Extract version from merged PR
+        run: |
+          BRANCH_NAME="${{ github.event.pull_request.head.ref }}"
+          VERSION=${BRANCH_NAME#release/}
+          echo "RELEASE_VERSION=$VERSION" >> $GITHUB_ENV
+
+      - name: Create PR
+        uses: thomaseizinger/create-pull-request@1.4.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          head: develop
+          base: master
+          title: Merge develop into master for release ${{ env.RELEASE_VERSION }}
+          reviewers: ${{ github.actor }} #Assign the PR to the user who merged the release branch
+          body: |
+            Hi @${{ github.actor }}!
+
+            This PR merges the develop branch into master for the release ${{ env.RELEASE_VERSION }}.
+            Once this PR is merged, the release will be published.
+
+            Happy merging!

.github/workflows/Release-3-Publish-new-release.yml

@@ -0,0 +1,33 @@
+name: "Release 3 - Publish new release"
+
+on:
+  pull_request:
+    branches:
+      - master
+    types:
+      - closed
+
+jobs:
+  release:
+    name: Publish new release
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.merged == true
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Get version from package.json
+        run: |
+          VERSION=$(node -e "console.log(require('./package.json').version)")
+          echo "RELEASE_VERSION=$VERSION" >> $GITHUB_ENV
+
+      - name: Create Release
+        uses: thomaseizinger/create-release@1.0.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          target_commitish: ${{ github.event.pull_request.merge_commit_sha }}
+          tag_name: ${{ env.RELEASE_VERSION }}
+          name: ${{ env.RELEASE_VERSION }}
+          draft: false
+          prerelease: false