fix: add pre version support to release generation (#26)

Author: toddeTV

.github/workflows/github-release-and-npm-package-publish.yml

@@ -13,17 +13,18 @@ jobs:
     permissions:
       contents: read
     outputs:
-      run_suffix_present: ${{ steps.check_run_suffix_present.outputs.run_suffix_present }}
-      run_suffix_force_version: ${{ steps.check_run_suffix_present.outputs.run_suffix_force_version }}
+      is_suffix_present: ${{ steps.check_create_release_suffix.outputs.is_suffix_present }}
+      is_version_bump: ${{ steps.check_create_release_suffix.outputs.is_version_bump }}
+      force_version: ${{ steps.check_create_release_suffix.outputs.force_version }}
     steps:
       - name: Checkout the Codebase
         uses: actions/checkout@v4
         with:
           ref: main # branch to checkout
           fetch-depth: 0
 
-      - name: Check commit message suffix for `[create-release]`
-        id: check_run_suffix_present
+      - name: Check commit message suffix for `[create-release-TYPE]`
+        id: check_create_release_suffix
         uses: actions/github-script@v7
         with:
           script: |
@@ -32,24 +33,45 @@ jobs:
             const lastCommitMessage = context.payload.head_commit.message;
             const lastCommitMessageFirstLine = lastCommitMessage.split('\n')[0];
 
-            let run_suffix_present = "false";
-            let run_suffix_force_version = "";
+            let is_suffix_present = "false";
+            let is_version_bump = "false";
+            let force_version = "";
+
+            const allowedTypes = [
+              "auto",
+              "major",
+              "minor",
+              "patch",
+              "premajor",
+              "preminor",
+              "prepatch",
+              "prerelease",
+            ];
 
             const regex = /\[create-release(?:-([a-z]+))?\]/;
             const match = lastCommitMessageFirstLine.match(regex);
 
             if (match) {
-              run_suffix_present = "true";
+              is_suffix_present = "true";
               if(match[1]){
-                run_suffix_force_version = `--${match[1]}`
+                if(!allowedTypes.includes(match[1])){
+                  throw new Error(`Invalid release TYPE: ${match[1]}`);
+                }
+                is_version_bump = "true";
+                if(match[1] !== "auto"){
+                  force_version = `--${match[1]}`
+                }
               }
             }
 
-            console.dir(`Set output: run_suffix_present=${run_suffix_present}`);
-            core.setOutput("run_suffix_present", run_suffix_present);
+            console.dir(`Set output: is_suffix_present=${is_suffix_present}`);
+            core.setOutput("is_suffix_present", is_suffix_present);
 
-            console.dir(`Set output: run_suffix_force_version=${run_suffix_force_version}`);
-            core.setOutput("run_suffix_force_version", run_suffix_force_version);
+            console.dir(`Set output: is_version_bump=${is_version_bump}`);
+            core.setOutput("is_version_bump", is_version_bump);
+
+            console.dir(`Set output: force_version=${force_version}`);
+            core.setOutput("force_version", force_version);
 
   dependence-lint:
     name: Depend on Lint
@@ -59,7 +81,7 @@ jobs:
     needs:
       - check_conditions
       - dependence-lint
-    if: needs.check_conditions.outputs.run_suffix_present == 'true'
+    if: needs.check_conditions.outputs.is_suffix_present == 'true'
     name: Create GitHub Release & NPM Publish
     runs-on: ubuntu-latest
     permissions:
@@ -86,20 +108,30 @@ jobs:
           git config --global user.name "github-actions[bot]"
           git config --global user.email "no-reply@todde.tv"
 
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
       # - name: Get old `package.json` version
       #   id: get_package_version_old
       #   run: echo version=$(node -p "require('./package.json').version") >> $GITHUB_OUTPUT
 
-      - name: Bump `package.json` version & generate changelog both from conventional commits
+      - name: Bump `package.json` version depending on given TYPE from commit message
+        if: needs.check_conditions.outputs.is_version_bump == 'true'
         # -from "v${{ steps.get_package_version_old.outputs.version }}"
-        run: pnpx changelogen@0.5.7 --output CHANGELOG.md --bump --no-commit --no-tag ${{ needs.check_conditions.outputs.run_suffix_force_version }}
+        run: pnpm changelogen --bump ${{ needs.check_conditions.outputs.force_version }} --no-commit --no-tag
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
 
       - name: Get new `package.json` version
         id: get_package_version_new
         run: echo version=$(node -p "require('./package.json').version") >> $GITHUB_OUTPUT
 
+      - name: Generate changelog from conventional commits
+        # -from "v${{ steps.get_package_version_old.outputs.version }}"
+        run: pnpm changelogen --output CHANGELOG.md -r "${{ steps.get_package_version_new.outputs.version }}" --no-commit --no-tag
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+
       - name: Git add, commit & push changes made to `package.json` & `CHANGELOG.md` to `main`
         run: |
           git add .
@@ -112,14 +144,13 @@ jobs:
           git push origin --tags
 
       - name: Sync tags with GitHub releases & create the new release
-        # run: pnpx changelogen@0.5.7 gh release "v${{ steps.get_package_version_new.outputs.version }}"
-        # run: pnpx changelogen@0.5.7 gh release
-        run: pnpx changelogen@0.5.7 gh release all
+        # run: pnpm changelogen gh release all
+        run: pnpm changelogen gh release "v${{ steps.get_package_version_new.outputs.version }}"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile
+      # - name: Install dependencies
+      #   run: pnpm install --frozen-lockfile
 
       - name: Build the project
         run: pnpm run build

README.dev.md

@@ -58,9 +58,11 @@ the GitHub workflow (CI action) that:
 
 - uses `pnpx changelogen` to analyze the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) from
   the last version to the current commit for:
-  - bumping the version in `package.json` via:
-    - automatically when no `TYPE` is given
-    - manually with a given `TYPE` where the following is possible:
+  - If no `TYPE` is present: Use the version from the `package.json` as target new version.<br>
+    So if the version already was changed via development this can be used to not bump another version on top.
+  - If no `TYPE` present: Bumping the version in `package.json` via:
+    - automatically when `TYPE` is `auto` depending on the detected semver changes.
+    - manually with the following `TYPE`:
       - `major`: Bump as a semver-major version
       - `minor`: Bump as a semver-minor version
       - `patch`: Bump as a semver-patch version

package.json

@@ -166,6 +166,7 @@
     "@antfu/eslint-config": "~3.16.0",
     "@types/node": "~22.10.7",
     "@types/three": "~0.172.0",
+    "changelogen": "0.5.7",
     "eslint": "~9.18.0",
     "eslint-plugin-format": "~1.0.1",
     "eslint-plugin-perfectionist": "~4.7.0",
@@ -180,7 +181,8 @@
   },
   "pnpm": {
     "patchedDependencies": {
-      "three-stdlib": "patches/three-stdlib.patch"
+      "three-stdlib": "patches/three-stdlib.patch",
+      "changelogen": "patches/changelogen.patch"
     }
   }
 }

patches/changelogen.patch

@@ -0,0 +1,30 @@
+diff --git a/dist/shared/changelogen.a79f5d5c.mjs b/dist/shared/changelogen.a79f5d5c.mjs
+index 901f6e360af4b6ea62758ebe28f0758d306a41f0..e8b5f4c3f9a94c7cd80344097950daea6fa499f8 100644
+--- a/dist/shared/changelogen.a79f5d5c.mjs
++++ b/dist/shared/changelogen.a79f5d5c.mjs
+@@ -395,8 +395,8 @@ function groupBy(items, key) {
+   }
+   return groups;
+ }
+-const CHANGELOG_RELEASE_HEAD_RE = /^#{2,}\s+.*(v?(\d+\.\d+\.\d+)).*$/gm;
+-const VERSION_RE = /^v?(\d+\.\d+\.\d+)$/;
++const CHANGELOG_RELEASE_HEAD_RE = /^#{2,}\s+.*(v?(\d+\.\d+\.\d+(-(rc\.)?\d+)?)).*$/gm;
++const VERSION_RE = /^v?(\d+\.\d+\.\d+(-(rc\.)?\d+)?)$/;
+ 
+ const defaultOutput = "CHANGELOG.md";
+ const getDefaultConfig = () => ({
+diff --git a/dist/shared/changelogen.c9085e7f.cjs b/dist/shared/changelogen.c9085e7f.cjs
+index 41e5865eb367763db7bc45aa1003bc0e7af4035b..e6dd6b133c4320c535541333d49540787db64c6c 100644
+--- a/dist/shared/changelogen.c9085e7f.cjs
++++ b/dist/shared/changelogen.c9085e7f.cjs
+@@ -397,8 +397,8 @@ function groupBy(items, key) {
+   }
+   return groups;
+ }
+-const CHANGELOG_RELEASE_HEAD_RE = /^#{2,}\s+.*(v?(\d+\.\d+\.\d+)).*$/gm;
+-const VERSION_RE = /^v?(\d+\.\d+\.\d+)$/;
++const CHANGELOG_RELEASE_HEAD_RE = /^#{2,}\s+.*(v?(\d+\.\d+\.\d+(-(rc\.)?\d+)?)).*$/gm;
++const VERSION_RE = /^v?(\d+\.\d+\.\d+(-(rc\.)?\d+)?)$/;
+ 
+ const defaultOutput = "CHANGELOG.md";
+ const getDefaultConfig = () => ({