build: use release-it to generate release data

.eslintrc.json

@@ -3,7 +3,13 @@
   // 👇 Added `(coverage|dist)/**/*` to be able to run 'eslint .' successfully
   //    When upgrading to v9, can include .gitignore here. In v8, you need to add a CLI flag
   //    Given 'eslint .' is not something ran often, it's good enough as ienough as is
-  "ignorePatterns": ["projects/**/*", "coverage/**/*", "dist/**/*", "!.*.json"],
+  "ignorePatterns": [
+    "projects/**/*",
+    "coverage/**/*",
+    "dist/**/*",
+    "!.*.json",
+    "!.*.ts"
+  ],
   "overrides": [
     {
       "files": ["*.ts", "*.mts"],

.github/workflows/reusable-build.yml

@@ -31,8 +31,9 @@ jobs:
       - name: Checkout
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
         with:
+          #👇 To generate release information
+          fetch-depth: 0
           ref: ${{ inputs.ref }}
-          lfs: true
       - name: Setup
         uses: ./.github/actions/setup
       - name: Generate info for Angular cache key

.gitignore

@@ -252,6 +252,7 @@ $RECYCLE.BIN/
 /junit-lint.xml
 /assets/*-subset.*
 /release.json
+/src/release.json
 /src/environments/environment.pull-request.ts
 .nx/cache
 .idea/git_toolbox_blame.xml

.npmrc

@@ -1 +1,2 @@
 enable-pre-post-scripts=false
+public-hoist-pattern[]=conventional-recommended-bump

.release-it.ts

@@ -0,0 +1,156 @@
+import { Config } from 'release-it'
+import { BumperRecommendation, Preset } from 'conventional-recommended-bump'
+
+export const createReleaseItConfig = ({
+  gitRawCommitsOpts,
+}: ExtraConfig = {}): Config => ({
+  git: {
+    commit: false,
+    push: false,
+  },
+  // @ts-expect-error Invalid type definition. TODO: PR for this
+  npm: false,
+  plugins: {
+    '@release-it/conventional-changelog': {
+      preset: {
+        name: 'conventionalcommits',
+        types: [
+          {
+            type: 'feat',
+            section: 'Features',
+          },
+          {
+            type: 'fix',
+            section: 'Bug Fixes',
+          },
+          {
+            type: 'perf',
+            section: 'Performance Improvements',
+          },
+          {
+            type: 'revert',
+            section: 'Reverts',
+          },
+          {
+            type: 'docs',
+            section: 'Documentation',
+          },
+          {
+            type: 'style',
+            section: 'Style',
+          },
+          {
+            type: 'chore',
+            section: 'Miscellaneous Chores',
+          },
+          {
+            type: 'refactor',
+            section: 'Code Refactoring',
+          },
+          {
+            type: 'test',
+            section: 'Tests',
+          },
+          {
+            type: 'build',
+            section: 'Build System',
+          },
+          {
+            type: 'ci',
+            section: 'Continuous (Integration|Deployment)',
+          },
+        ],
+      },
+      whatBump,
+      gitRawCommitsOpts,
+    },
+  },
+})
+
+/**
+ * ⚠️ Conventional Changelog version bumpers always returns at least a patch release
+ *
+ * Therefore, `release-it/conventional-changelog` behaves the same, as it's just a wrapper over it
+ * Here, the recommended version bumper is tuned so that not every commit triggers a version bump.
+ *
+ * See:
+ *
+ *  - GitHub issue about it:   https://github.com/release-it/conventional-changelog/issues/22
+ *  - Original implementation: https://github.com/conventional-changelog/conventional-changelog/blob/conventional-recommended-bump-v10.0.0/packages/conventional-changelog-conventionalcommits/src/whatBump.js
+ *
+ * @param commits
+ */
+const whatBump: Preset['whatBump'] = async (commits) => {
+  const commitsByLevel = commits.reduce(
+    (results, commit) => {
+      const addToResults = (key: number) => {
+        results[key].push(commit)
+        return results
+      }
+      // As notes are only parsed for breaking changes
+      // https://github.com/conventional-changelog/conventional-changelog/blob/conventional-recommended-bump-v10.0.0/packages/conventional-changelog-conventionalcommits/src/parser.js
+      const hasBreakingChanges = addBangNotes(commit).length > 0
+      if (hasBreakingChanges) {
+        return addToResults(RELEASE_LEVEL_MAJOR)
+      }
+      if (commit.type === 'feat' || commit.type === 'feature') {
+        return addToResults(RELEASE_LEVEL_MINOR)
+      }
+      if (commit.type === 'fix' || commit.type === 'perf') {
+        return addToResults(RELEASE_LEVEL_PATCH)
+      }
+      return results
+    },
+    [[], [], []] as [Commit[], Commit[], Commit[]],
+  )
+  const level = ifMinusOneToUndefined(
+    commitsByLevel.findIndex((commits) => commits.length > 0),
+  ) as BumperRecommendation['level']
+  const reason =
+    level === undefined
+      ? 'No commit needs to be released according to bump rules'
+      : 'These are the commits that triggered a release. The highest release level was chosen\n' +
+        commitsByLevel
+          .map(
+            (commitHeaders, level) =>
+              ` - ${RELEASE_LEVEL_NAMES[level]}: ${commitHeaders.map((header) => `"${header}"`).join(', ')}`,
+          )
+          .join('\n')
+  return { level, reason }
+}
+
+export type ExtraConfig = Partial<{
+  gitRawCommitsOpts: { from: string; to: string }
+}>
+
+// https://github.com/conventional-changelog/conventional-changelog/blob/conventional-changelog-conventionalcommits-v8.0.0/packages/conventional-changelog-conventionalcommits/src/utils.js
+function addBangNotes(commit: Commit) {
+  const breakingHeaderPattern = /^(\w*)(?:\((.*)\))?!: (.*)$/
+  const match = commit.header?.match(breakingHeaderPattern)
+  if (match && commit.notes.length === 0) {
+    const noteText = match[3] // the description of the change.
+
+    return [
+      {
+        title: 'BREAKING CHANGE',
+        text: noteText,
+      },
+    ]
+  }
+
+  return commit.notes
+}
+
+// https://stackoverflow.com/a/52331580/3263250
+type Unpacked<T> = T extends (infer U)[] ? U : T
+type Commit = Unpacked<Parameters<Preset['whatBump']>[0]>
+
+const ifMinusOneToUndefined = (n: number) => (n !== -1 ? n : undefined)
+
+// https://github.com/conventional-changelog/conventional-changelog/blob/conventional-recommended-bump-v10.0.0/packages/conventional-recommended-bump/src/bumper.ts#L24-L28
+const RELEASE_LEVEL_NAMES = ['major', 'minor', 'patch'] as const
+const [RELEASE_LEVEL_MAJOR, RELEASE_LEVEL_MINOR, RELEASE_LEVEL_PATCH] = [
+  ...RELEASE_LEVEL_NAMES.keys(),
+]
+
+export default createReleaseItConfig()

angular.json

@@ -41,6 +41,7 @@
               "src/assets",
               "src/site.webmanifest",
               "src/browserconfig.xml",
+              "src/release.json",
               {
                 "glob": "profile.jpg",
                 "input": "src/",

package.json

@@ -40,8 +40,11 @@
     "lint:gh-actions": "actionlint || true",
     "prebuild:font-subsets": "tsm scripts/src/generate-font-subsets.ts",
     "prebuild:release-file": "tsx scripts/src/generate-release-file.mts",
+    "prebuild:release-info": "tsx scripts/src/generate-release-info.mts",
     "prebuild:render-templates": "tsm scripts/src/generate-templated-files.ts",
     "prebuild:simple-icons": "tsm scripts/src/generate-simple-icons.ts",
+    "release:dry-run": "release-it --dry-run",
+    "release:dry-run:local": "pnpm run release:dry-run --no-git.requireCleanWorkingDir --no-git.requireUpstream",
     "security-txt": "tsm scripts/src/generate-security-txt.ts",
     "serve:ssr:@davidlj95/website": "node dist/@davidlj95/website/server/server.mjs",
     "start": "ng serve",
@@ -94,6 +97,7 @@
     "@commitlint/types": "19.5.0",
     "@cypress/code-coverage": "3.13.4",
     "@lhci/cli": "0.14.0",
+    "@release-it/conventional-changelog": "9.0.3",
     "@types/compression": "1.7.5",
     "@types/express": "4.17.21",
     "@types/jasmine": "5.1.4",
@@ -127,6 +131,7 @@
     "ng-mocks": "14.13.1",
     "nyc": "17.1.0",
     "prettier": "3.3.3",
+    "release-it": "17.10.0",
     "semantic-release": "24.2.0",
     "subset-font": "2.3.0",
     "tsm": "2.3.0",