feat: release type read and implemented

Author: laxmanpokhrel

.github/scripts/release.sh

@@ -121,7 +121,7 @@ fi
 
 # Check if release notes are available
 echo "- reading release notes"
-RELEASE_NOTES=$(cat .release/release-notes.md)
+RELEASE_NOTES=$(cat .release/release-notes.txt)
 
 if [ $? != 0 ]; then
     echo "- release notes not provided"

.release/config.json

@@ -1,4 +1,3 @@
 {
-  "versionUpgradeType": "patch",
-  "releaseType": "--prerelease"
+  "versionUpgradeType": "minor"
 }

.release/release-notes.md

@@ -0,0 +1,3 @@
+## Changes
+- Conditional step for creatinf pr only if release is non prerelease
+- Release notes in .txt file

.release/release-notes.txt

@@ -7,7 +7,8 @@ echo "=========================================================="
 
 # Declerations
 RELEASE_CONFIG_FILE=null
-RELEASE_TYPE=null
+VERSION_UPGRADE_TYPE=null
+RELEASE_TYPE=''
 TAG=null
 
 PACKAGEJSON=$(cat package.json)
@@ -30,15 +31,27 @@ fi
 # Check if release config file has `versionUpgradeType`
 echo "- reading 'versionUpgradeType'"
 if [ "$(echo "$RELEASE_CONFIG_FILE" | jq -r ".versionUpgradeType")" != "null" ]; then
-    RELEASE_TYPE=$(echo "$RELEASE_CONFIG_FILE" | jq -r ".versionUpgradeType")
-    echo "- 'versionUpgradeType': $RELEASE_TYPE"
+    VERSION_UPGRADE_TYPE=$(echo "$RELEASE_CONFIG_FILE" | jq -r ".versionUpgradeType")
+    echo "- 'versionUpgradeType': $VERSION_UPGRADE_TYPE"
 else
-    RELEASE_TYPE=null
+    VERSION_UPGRADE_TYPE=null
     echo "- no 'versionUpgradeType' provided"
     echo "- abort"
     exit 1
 fi
 
+# Check if release config file has `releaseType`
+echo "- reading 'releaseType'"
+if [ "$(echo "$RELEASE_CONFIG_FILE" | jq -r ".releaseType")" != "null" ]; then
+    RELEASE_TYPE=$(echo "$RELEASE_CONFIG_FILE" | jq -r ".releaseType")
+    echo "- 'releaseType': $RELEASE_TYPE"
+else
+    RELEASE_TYPE=''
+    echo "- no 'releaseType' provided"
+    echo "- abort"
+    exit 1
+fi
+
 # Check if npm view command succeeded or failed
 echo "- reading package version from npm"
 PACKAGE_NPM_VERSION=$(npm view $PACKAGE_NAME version 2>/dev/null)
@@ -54,7 +67,7 @@ else
     FINAL_RELEASE_VERSION=$PACKAGE_VERSION
 fi
 
-# Function to update version based on RELEASE_TYPE
+# Function to update version based on VERSION_UPGRADE_TYPE
 update_version() {
     local current_version=$1
     local release_type=$2
@@ -84,14 +97,14 @@ update_version() {
 if [ "$PACKAGE_NPM_VERSION" == "null" ]; then
     FINAL_RELEASE_VERSION=$PACKAGE_VERSION
 else
-    case $RELEASE_TYPE in
+    case $VERSION_UPGRADE_TYPE in
     "major" | "minor" | "patch")
         echo "- analysing version"
-        FINAL_RELEASE_VERSION=$(update_version "$PACKAGE_NPM_VERSION" "$RELEASE_TYPE") TAG=$FINAL_RELEASE_VERSION
+        FINAL_RELEASE_VERSION=$(update_version "$PACKAGE_NPM_VERSION" "$VERSION_UPGRADE_TYPE") TAG=$FINAL_RELEASE_VERSION
         echo "- analysed deployable version $FINAL_RELEASE_VERSION"
         ;;
     *)
-        echo "- invalid release type: $RELEASE_TYPE"
+        echo "- invalid release type: $VERSION_UPGRADE_TYPE"
         ;;
     esac
 fi
@@ -108,7 +121,7 @@ fi
 
 # Check if release notes are available
 echo "- reading release notes"
-RELEASE_NOTES=$(cat .release/release-notes.md)
+RELEASE_NOTES=$(cat .release/release-notes.txt)
 
 if [ $? != 0 ]; then
     echo "- release notes not provided"
@@ -121,12 +134,14 @@ echo "- RELEASE_NOTES: $RELEASE_NOTES"
 echo "- PACKAGE_NAME: $PACKAGE_NAME"
 echo "- PACKAGE_VERSION: $PACKAGE_VERSION"
 echo "- FINAL_RELEASE_VERSION: $FINAL_RELEASE_VERSION"
-echo "- RELEASE_TYPE:$RELEASE_TYPE"
-echo "- TAG:$TAG"
+echo "- VERSION_UPGRADE_TYPE: $VERSION_UPGRADE_TYPE"
+echo "- TAG: $TAG"
+echo "- RELEASE_TYPE: $RELEASE_TYPE"
 
 # Set output
 echo "tag=$(echo $TAG)" >>$GITHUB_OUTPUT
 echo "release-notes=$(echo $RELEASE_NOTES)" >>$GITHUB_OUTPUT
 echo "final-release-version=$(echo $FINAL_RELEASE_VERSION)" >>$GITHUB_OUTPUT
-echo "release-type=$(echo $RELEASE_TYPE)" >>$GITHUB_OUTPUT
+echo "release-type=$(echo $VERSION_UPGRADE_TYPE)" >>$GITHUB_OUTPUT
 echo "package-version=$(echo $PACKAGE_VERSION)" >>$GITHUB_OUTPUT
+echo "release-type=$(echo $RELEASE_TYPE)" >>$GITHUB_OUTPUT

registry/release.sh

@@ -1,8 +1,9 @@
-name: Release Test
+name: Deploy and Release
 on:
+  workflow_dispatch:
   push:
     branches:
-      - <your_release_branch_name>
+      - main
     paths:
       - .release/*
 permissions:
@@ -13,7 +14,6 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout
       - name: Checkout
         uses: actions/checkout@v4
 
@@ -53,6 +53,16 @@ jobs:
           name: get-release-props-logs
           path: get-release-props-logs.log
 
+      - name: Debug variables
+        run: |
+          echo "tag=${{steps.read-release-props.outputs.tag}}"
+          echo "release-notes=${{steps.read-release-props.outputs.release-notes}}"
+          echo "package-version: ${{steps.read-release-props.outputs.package-version}}"
+          echo "release-type: ${{steps.read-release-props.outputs.release-type}}"
+          echo "final-release-version: ${{steps.read-release-props.outputs.final-release-version}}"
+          echo "release-type: ${{steps.read-release-props.outputs.release-type}}"
+          echo "isPrerelease: ${{steps.read-release-props.outputs.release-type}} == '--prerelease'"
+
       - name: Checkout to new branch and update package json with new version
         id: branch-checkout-details
         run: |
@@ -72,6 +82,9 @@ jobs:
           echo "current_branch=$(echo $current_branch)" >>$GITHUB_OUTPUT
           echo "checkout_branch_name=$(echo $checkout_branch_name)" >>$GITHUB_OUTPUT
 
+      - name: Check branch
+        run: git branch
+
       - name: Install package
         run: yarn install
 
@@ -94,9 +107,11 @@ jobs:
           gh release create "$tag" \
             --repo="$GITHUB_REPOSITORY" \
             --title="$title" \
-            --notes="${{ steps.read-release-props.outputs.release-notes }}"
+            --notes="${{ steps.read-release-props.outputs.release-notes }}" \
+            ${{steps.read-release-props.outputs.release-type}}
 
       - name: Push and raise a PR
+        if: ${{steps.read-release-props.outputs.release-type != '--prerelease'}}
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |

registry/release.yaml

@@ -67,9 +67,9 @@ export default async function createRelease() {
     return; // Exit function if there's an error creating the directory
   }
 
-  // If there are releaseNotes then create a file named .release/release-notes.md
+  // If there are releaseNotes then create a file named .release/release-notes.txt
   if (releaseNotes.value) {
-    await writeFileAsync(".release/release-notes.md", releaseNotes.value);
+    await writeFileAsync(".release/release-notes.txt", releaseNotes.value);
     logger.info("Release notes saved.");
   }