Make enclosing brackets for version number optional

Author: RaumZeit

.github/workflows/ci.yml

@@ -167,3 +167,15 @@ jobs:
         RELEASE_NOTES: ${{ steps.extract-release-notes-11.outputs.release_notes }}
       run: |
         diff <(echo -n "${RELEASE_NOTES}") test/testdata/expected/RELEASE_NOTES_6.md
+    - name: Run action
+      id: extract-release-notes-12
+      uses: ./
+      with:
+        changelog_file: test/testdata/CHANGELOG_7.md
+        version_prefix: version
+    - name: Assert that release_notes contains expected content
+      shell: bash
+      env:
+        RELEASE_NOTES: ${{ steps.extract-release-notes-12.outputs.release_notes }}
+      run: |
+        diff <(echo -n "${RELEASE_NOTES}") test/testdata/expected/RELEASE_NOTES_1.md

.github/workflows/test.yml

@@ -111,6 +111,10 @@ jobs:
           expected_release_notes_file: RELEASE_NOTES_6.md
           prerelease: false
           header_level: 3
+        - changelog_file: CHANGELOG_7.md
+          expected_release_notes_file: RELEASE_NOTES_1.md
+          prerelease: false
+          version_prefix: version
     runs-on: ${{ matrix.os }}
     steps:
     - name: Checkout
@@ -153,6 +157,10 @@ jobs:
           expected_release_notes_file: RELEASE_NOTES_6.md
           prerelease: false
           header_level: 3
+        - changelog_file: CHANGELOG_7.md
+          expected_release_notes_file: RELEASE_NOTES_1.md
+          prerelease: false
+          version_prefix: version
     runs-on: ${{ matrix.os }}
     steps:
     - name: Checkout

CHANGELOG.md

@@ -12,6 +12,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - Allow for version number prefix in the changelog header tag, e.g. `version` as in [version x.y.z]
 - Allow for changing the header level (default 2) where the version description is expected
+- Allow for omitting enclosing brackets of version number
 
 ### Changed
 

src/index.js

@@ -44,8 +44,8 @@ async function extractReleaseNotes(changelogFile, prerelease, versionPrefix, hea
     const header_level = (Number.isInteger(headerLevel) && (headerLevel > 0) && (headerLevel < 7)) ? +headerLevel : 2
     const level_match_regex = "^#{" + header_level + "}\\s+"
     const levelup_match_regex = (header_level > 1) ? "^#{1," + (header_level - 1) + "}\\s+" : level_match_regex
-    const version_match_regex = "\\[" + escapeRegex(versionPrefix) + "\\s*[0-9]"
-    const unreleases_match_regex = "\\[Unreleased\\]"
+    const version_match_regex = "\\[?" + escapeRegex(versionPrefix) + "\\s*[0-9]"
+    const unreleases_match_regex = "\\[?Unreleased\\]?"
     core.debug(`version_match_regex: '${version_match_regex}'`)
     core.debug(`unrelease_match_regex: '${unreleases_match_regex}'`)
     for await (const line of rl) {

test/testdata/CHANGELOG_7.md

@@ -0,0 +1,48 @@
+<!-- SPDX-License-Identifier: MIT -->
+
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security
+
+## version 1.0 - 2024-05-21
+
+### Added
+
+- Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
+- At vero eos et accusam et justo duo dolores et ea rebum.
+- Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+- Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
+- At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+
+### Changed
+
+- At vero eos et accusam et justo duo dolores et ea rebum.
+- Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+
+### Removed
+
+- At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+
+## version 0.1 - 2019-12-01
+
+### Added
+
+- Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
+- At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+- Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.