feat: reading release type

Author: laxmanpokhrel

.github/scripts/release.sh

@@ -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
@@ -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

.github/workflows/release.yaml

@@ -42,6 +42,7 @@ jobs:
           git config --global user.email $USER_EMAIL
 
       - name: Commit logs
+        continue-on-error: true
         run: |
           git add .
           git commit -m "ci: Release props logs generated."
@@ -52,15 +53,6 @@ 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 "final-release-version: ${{steps.read-release-props.outputs.final-release-version}}"
-
       - name: Checkout to new branch and update package json with new version
         # if: steps.read-release-props.outcome.package-version != steps.read-release-props.outputs.final-release-version
         # continue-on-error: true
@@ -124,4 +116,5 @@ jobs:
           --base ${{steps.branch-checkout-details.outputs.current_branch}} \
           --title "version ${{steps.read-release-props.outputs.final-release-version}}" \
           --body "* version: ${{steps.read-release-props.outputs.final-release-version}} | $(date -u +"%Y-%m-%d %H:%M:%S")" \
-          --no-maintainer-edit
+          --no-maintainer-edit \
+          ${{steps.read-release-props.outputs.release-type}}

.release/config.json

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

.release/release-notes.md

@@ -1,5 +1 @@
-## Fixes
-- Wait for flags task to complete before exit
-
-## Changes
-- Updated documentation
+## Presease to check if reading release type is working

src/tasks/createRelease.ts

@@ -28,6 +28,15 @@ export default async function createRelease() {
   ]);
 
   // Read release type
+  const releaseType = await inquirer.prompt([
+    {
+      type: "list",
+      name: "value",
+      message: "Choose your version upgrade type:",
+      choices: ["--latest (default)", "--prerelease"],
+    },
+  ]);
+  // Read version upgrade type
   const versionUpgradeType = await inquirer.prompt([
     {
       type: "list",
@@ -58,13 +67,13 @@ export default async function createRelease() {
     return; // Exit function if there's an error creating the directory
   }
 
-  // 1. 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.md
   if (releaseNotes.value) {
     await writeFileAsync(".release/release-notes.md", releaseNotes.value);
     logger.info("Release notes saved.");
   }
 
-  // 2. If there is a tag, add the tag to .release/config.json
+  // If there is a tag, add the tag to .release/config.json
   if (tag.value.length) {
     const config = { tag: tag.value };
     await writeFileAsync(
@@ -74,7 +83,7 @@ export default async function createRelease() {
     logger.info("Tag added to config.");
   }
 
-  // 3. If there is a versionUpgradeType, add the versionUpgradeType to .release/config.json
+  // If there is a versionUpgradeType, add the versionUpgradeType to .release/config.json
   if (versionUpgradeType.value) {
     try {
       await accessAsync(".release/config.json", fs.constants.F_OK);
@@ -108,6 +117,40 @@ export default async function createRelease() {
     logger.info("VersionUpgradeType added to config.");
   }
 
+  // If there is a release type, add the releaseType to .release/config.json
+  if (releaseType.value) {
+    try {
+      await accessAsync(".release/config.json", fs.constants.F_OK);
+    } catch (error) {
+      if (error.code === "ENOENT") {
+        // File doesn't exist, create it with default content
+
+        const defaultConfig = { releaseType: "--latest" };
+        await writeFileAsync(
+          ".release/config.json",
+          JSON.stringify(defaultConfig, null, 2)
+        );
+        logger.info("Config file created.");
+      }
+    }
+
+    const configFileContent = await readFileAsync(
+      ".release/config.json",
+      "utf-8"
+    );
+
+    const configFile = JSON.parse(configFileContent);
+    const config = {
+      ...configFile,
+      releaseType: releaseType.value.split(" ")[0],
+    };
+    await writeFileAsync(
+      ".release/config.json",
+      JSON.stringify(config, null, 2)
+    );
+    logger.info("VersionUpgradeType added to config.");
+  }
+
   console.log(`
 ${chalk.cyan.bold(
   "\n----------------------------------------------------------------------------------------------------------------------------------------------"