fix: 🐛 fix and test changelog

.github/fixtures/changelog-traefik-crds.md

@@ -0,0 +1,10 @@
+## [crds_v1.1.0](https://github.com/traefik/traefik-helm-chart/compare/crds_v1.0.0...crds_v1.1.0) (2025-01-13)
+## :rocket: Features
+
+- feat(CRDs): update CRDs for Traefik Proxy v3.3.x #1303 by @mloiseleur
+
+## :bug: Bug fixes
+
+- fix(CRDs): :bug: bad regexp to generate CRDs release notes #1302 by @darkweaver87
+
+

.github/fixtures/changelog-traefik.md

@@ -0,0 +1,16 @@
+## [v34.2.0](https://github.com/traefik/traefik-helm-chart/compare/v34.1.0...v34.2.0) (2025-01-28)
+## :rocket: Features
+
+- feat: :sparkles: add hub tracing capabilities #1322 by @darkweaver87
+
+## :bug: Bug fixes
+
+- fix: :bug: permanent redirect should be disableable #1319 by @darkweaver87
+
+## :package: Others
+
+- chore: update issue template #1316 by @mloiseleur
+- docs: 📚️ fix typo in Guidelines.md #1320 by @lbarnkow
+- chore(release): publish v34.2.0 #1323 by @darkweaver87
+
+

.github/workflows/changelog.json

@@ -5,7 +5,7 @@
       "title": "## :boom: BREAKING CHANGES",
       "rules": [
         {
-          "pattern": ".*\\((${REGEXP}).*\\)!:.*",
+          "pattern": ".*${REGEXP}!:.*",
           "on_property": "title",
           "flags": "gu"
         }
@@ -15,7 +15,7 @@
       "title": "## :rocket: Features",
       "rules": [
         {
-          "pattern": "feat\\((${REGEXP}).*\\):.*",
+          "pattern": "feat${REGEXP}:.*",
           "on_property": "title",
           "flags": "gu"
         }
@@ -25,7 +25,7 @@
       "title": "## :bug: Bug fixes",
       "rules": [
         {
-          "pattern": "fix\\((${REGEXP}).*\\):.*",
+          "pattern": "fix${REGEXP}:.*",
           "on_property": "title",
           "flags": "gu"
         }
@@ -35,7 +35,7 @@
       "title": "## :package: Others",
       "rules": [
         {
-          "pattern": "(chore|release)\\((${REGEXP}).*\\):.*",
+          "pattern": "(build|chore|ci|docs|style|refactor|perf|test)${REGEXP}:.*",
           "on_property": "title",
           "flags": "gu"
         }

.github/workflows/release.yml

@@ -72,7 +72,7 @@ jobs:
 
       - name: Render changelog configuration
         env:
-          REGEXP: "?!CRDs-"
+          REGEXP: '(\\(.+\\)|(?!\\(CRDs-.+\\)))'
         run: |
           export DATE=$(date +%F); cat .github/workflows/changelog.json | envsubst > /tmp/changelog.json; cat /tmp/changelog.json
         if: steps.tag_exists.outputs.TAG_EXISTS == 'false'
@@ -183,7 +183,7 @@ jobs:
 
       - name: Render changelog configuration
         env:
-          REGEXP: "CRDs"
+          REGEXP: '\\((CRDs|CRDs-.+)\\)'
         run: |
           export DATE=$(date +%F); cat .github/workflows/changelog.json | envsubst > /tmp/changelog.json; cat /tmp/changelog.json
         if: steps.tag_exists.outputs.TAG_EXISTS == 'false'

.github/workflows/test-release.yaml

@@ -0,0 +1,83 @@
+---
+name: Test release
+
+on:
+  pull_request:
+    paths:
+      - .github/fixtures/changelog-traefik.md
+      - .github/fixtures/changelog-traefik-crds.md
+      - .github/workflows/release.yaml
+      - .github/workflows/changelog.json
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Render traefik changelog configuration
+        env:
+          REGEXP: '(\\(.+\\)|(?!\\(CRDs-.+\\)))'
+        run: |
+          export DATE=2025-01-28; cat .github/workflows/changelog.json | envsubst > /tmp/changelog.json; cat /tmp/changelog.json
+
+      - name: Build Changelog
+        id: changelog
+        uses: mikepenz/release-changelog-builder-action@v5
+        with:
+          fromTag: v34.1.0
+          toTag: v34.2.0
+          configuration: "/tmp/changelog.json"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Write changelog
+        run: |
+          cat <<EOF > /tmp/changelog.md
+          ${{ steps.changelog.outputs.changelog }}
+          EOF
+
+      - name: Check that the files are the exact same
+        uses: LouisBrunner/[email protected]
+        with:
+          old: .github/fixtures/changelog-traefik.md
+          new: /tmp/changelog.md
+          mode: strict
+          tolerance: same
+
+  test-crds:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Render traefik changelog configuration
+        env:
+          REGEXP: '\\((CRDs|CRDs-.+)\\)'
+        run: |
+          export DATE=2025-01-13; cat .github/workflows/changelog.json | envsubst > /tmp/changelog.json; cat /tmp/changelog.json
+
+      - name: Build Changelog
+        id: changelog
+        uses: mikepenz/release-changelog-builder-action@v5
+        with:
+          fromTag: crds_v1.0.0
+          toTag: crds_v1.1.0
+          configuration: "/tmp/changelog.json"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Write changelog
+        run: |
+          cat <<EOF > /tmp/changelog.md
+          ${{ steps.changelog.outputs.changelog }}
+          EOF
+
+      - name: Check that the files are the exact same
+        uses: LouisBrunner/[email protected]
+        with:
+          old: .github/fixtures/changelog-traefik-crds.md
+          new: /tmp/changelog.md
+          mode: strict
+          tolerance: same

CONTRIBUTING.md

@@ -36,7 +36,7 @@ Commits messages should follow [conventional commits](https://www.conventionalco
 All commits will appear in traefik helm chart changelog with two exceptions:
 
 - CRDs: CRDs are shared between Traefik and CRDs charts, thus, commits with this scope will appear in both charts changelog (e.g. `feat(CRDs): update Traefik Proxy CRDs to v3.x`)
-- CRDs-.*: commits with `CRDs-` prefixed scope will appear only on CRDs chart changelog (e.g. `docs(CRDs-values: update values documentation`)   
+- CRDs-.*: commits with `CRDs-` prefixed scope will appear only on CRDs chart changelog (e.g. `docs(CRDs-values): update values documentation`)   
 
 # Statistics