Merge pull request #1590 from mikepenz/develop

dev -> main

Author: mikepenz

.devcontainer/devcontainer.json

@@ -2,7 +2,7 @@
 // README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node
 {
 	"name": "Node.js & TypeScript",
-	"image": "mcr.microsoft.com/devcontainers/typescript-node:24-bullseye@sha256:14e1448d47b65dd61a6dc1476b4f391643174abd70b64069b9644e0ad1bdb152",
+	"image": "mcr.microsoft.com/devcontainers/typescript-node:24-bullseye@sha256:147a65f600d906c678cb40b7fa17957b943f49cf3a094c2a1ad56044605f87e8",
 	"features": {
 		"ghcr.io/devcontainers/features/node:1": {}
 	},

.github/workflows/check-dist.yml

@@ -27,10 +27,10 @@ jobs:
       contents: read
 
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
 
       - name: Set Node.js 24.x
-        uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f  # v6
+        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e  # v6.4.0
         with:
           node-version: 24.x
 
@@ -50,7 +50,7 @@ jobs:
         id: diff
 
       # If index.js was different than expected, upload the expected version as an artifact
-      - uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f  # v7
+      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a  # v7.0.1
         if: ${{ failure() && steps.diff.conclusion == 'failure' }}
         with:
           name: dist

.github/workflows/ci.yml

@@ -19,13 +19,13 @@ jobs:
       pull-requests: write
     steps:
       - name: Checkout
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
         with:
           fetch-depth: 100
           fetch-tags: true
 
       - name: Set Node.js 24.x
-        uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f  # v6
+        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e  # v6.4.0
         with:
           node-version: 24.x
 
@@ -46,7 +46,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Publish Test Report
-        uses: mikepenz/action-junit-report@49b2ca06f62aa7ef83ae6769a2179271e160d8e4  # v6
+        uses: mikepenz/action-junit-report@bccf2e31636835cf0874589931c4116687171386  # v6.4.0
         if: success() || failure() # always run even if the previous step fails
         with:
           report_paths: 'junit.xml'
@@ -59,16 +59,16 @@ jobs:
       github.event_name == 'pull_request' &&
       startsWith(github.head_ref, 'renovate/') &&
       github.event.pull_request.head.repo.full_name == github.repository &&
-      github.actor == github.repository_owner
+      (github.actor == github.repository_owner || github.actor == 'renovate-mike[bot]')
     runs-on: ubuntu-latest
     permissions:
       contents: write
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
         with:
           ref: ${{ github.event.pull_request.head.ref }}
           persist-credentials: false
-      - uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f  # v6
+      - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e  # v6.4.0
         with:
           node-version: 24.x
       - run: npm ci && npm run build && npm run package
@@ -131,7 +131,7 @@ jobs:
         run: echo "CHANGELOG"
 
       - name: Checkout
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
         with:
           fetch-depth: 0
 
@@ -226,10 +226,10 @@ jobs:
       attestations: write
     steps:
       - name: Checkout
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
 
       - name: Set Node.js 24.x
-        uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f  # v6
+        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e  # v6.4.0
         with:
           node-version: 24.x
 
@@ -238,20 +238,20 @@ jobs:
 
       - name: "Build Changelog"
         id: github_release
-        uses: mikepenz/release-changelog-builder-action@a34a8009a9588bb86b02a873cf592440e96a5da8  # v6
+        uses: mikepenz/release-changelog-builder-action@bcae7115752d4ed746ff92feb666574428a79415  # v6.2.1
         with:
           configuration: "configs/configuration_repo.json"
           ignorePreReleases: ${{ !contains(github.ref, '-') }}
           token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Create Release
-        uses: mikepenz/action-gh-release@5c3d16ffbdc3e0fbfe2c8a69a448798f5d9b30c2  # v2
+        uses: mikepenz/action-gh-release@2a00e201320fb618d8e705a736286b2e31aa48e2  # v3.0.0
         with:
           body: ${{steps.github_release.outputs.changelog}}
           prerelease: ${{ contains(github.ref, '-rc') || contains(github.ref, '-b') || contains(github.ref, '-a') }}
           token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Attest build provenance
-        uses: actions/attest-build-provenance@a2bbfa25375fe432b6a289bc6b6cd05ecd0c4c32  # v4
+        uses: actions/attest-build-provenance@a2bbfa25375fe432b6a289bc6b6cd05ecd0c4c32  # v4.1.0
         with:
           subject-path: dist/index.js

.github/workflows/codeql-analysis.yml

@@ -43,11 +43,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
+      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
 
     # Initializes the CodeQL tools for scanning. 
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@38697555549f1db7851b81482ff19f1fa5c4fedc  # v4.34.1
+      uses: github/codeql-action/init@95e58e9a2cdfd71adc6e0353d5c52f41a045d225  # v4.35.2
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -58,7 +58,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@38697555549f1db7851b81482ff19f1fa5c4fedc  # v4.34.1
+      uses: github/codeql-action/autobuild@95e58e9a2cdfd71adc6e0353d5c52f41a045d225  # v4.35.2
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -72,4 +72,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@38697555549f1db7851b81482ff19f1fa5c4fedc  # v4.34.1
+      uses: github/codeql-action/analyze@95e58e9a2cdfd71adc6e0353d5c52f41a045d225  # v4.35.2

__tests__/releaseNotesBuilder.test.ts

@@ -17,7 +17,7 @@ test('[Github] Should match generated changelog (unspecified fromTag)', async ()
     'mikepenz',
     'release-changelog-builder-action',
     null,
-    'v0.0.3',
+    'v6.1.1',
     false,
     false,
     false,
@@ -34,10 +34,10 @@ test('[Github] Should match generated changelog (unspecified fromTag)', async ()
 
   const changeLog = await releaseNotesBuilder.build()
   console.log(changeLog)
-  expect(changeLog).toStrictEqual(`## 🧪 Tests
+  expect(changeLog).toStrictEqual(`## 🚀 Features
 
-- [CI] Specify Test Case
-   - PR: #10
+- Upgrade all dependencies and move to ESLint 10
+   - PR: #1521
 
 `)
 })

__tests__/transform.test.ts

@@ -710,3 +710,55 @@ test('Use Rules to get all open PRs in one Category and merged categorised.', as
     `## Open PRs only\n\n- Still pending open pull request\n   - PR: #6\n\n## 🚀 Features and 🐛 Issues\n\n- [ABC-1234] - this is a PR 3 title message\n   - PR: #3\n\n`
   )
 })
+
+const mkPr = (number: number, title: string, label: string): PullRequestInfo => ({
+  number,
+  title,
+  htmlURL: '',
+  baseBranch: '',
+  createdAt: moment(),
+  mergedAt: moment(),
+  mergeCommitSha: `sha${number}`,
+  author: 'octocat',
+  authorName: 'octocat',
+  repoName: 'test-repo',
+  labels: [label],
+  milestone: '',
+  body: '',
+  assignees: [],
+  requestedReviewers: [],
+  approvedReviewers: [],
+  status: 'merged'
+})
+
+const specialCharsConfig: Configuration = Object.assign({}, DefaultConfiguration, {
+  categories: [
+    {title: '## Features', labels: ['feature']},
+    {title: '## Bugs', labels: ['bug']},
+    {title: '## Tests', labels: ['test']}
+  ],
+  template: '#{{CHANGELOG}}',
+  pr_template: '* #{{TITLE}} by @#{{AUTHOR}} in ##{{NUMBER}}'
+})
+
+test('PR titles with backtick code spans render verbatim', async () => {
+  const prs = [
+    mkPr(269, 'Fix unit test for `String.Format()`', 'test'),
+    mkPr(270, 'Improvements in `String` class', 'feature'),
+    mkPr(271, 'Rewrote `Guid.CompareTo`', 'bug')
+  ]
+  const out = buildChangelogTest(specialCharsConfig, prs, repositoryUtils)
+  expect(out).toContain('* Fix unit test for `String.Format()` by @octocat in #269')
+  expect(out).toContain('* Improvements in `String` class by @octocat in #270')
+  expect(out).toContain('* Rewrote `Guid.CompareTo` by @octocat in #271')
+})
+
+test('PR titles with $-escape sequences render verbatim', async () => {
+  const prs = [
+    mkPr(101, 'weird $& and $1 and $$ chars', 'bug'),
+    mkPr(102, "edge $` and $' and $0 and $<name>", 'bug')
+  ]
+  const out = buildChangelogTest(specialCharsConfig, prs, repositoryUtils)
+  expect(out).toContain('* weird $& and $1 and $$ chars by @octocat in #101')
+  expect(out).toContain("* edge $` and $' and $0 and $<name> by @octocat in #102")
+})