When using this plugin together with github's auto changelog generator, it ends up creating invalid changelog, as GitHub by default uses a h2, not a h3 for their headers.

Taking a look at Laravel Health from Spatie, we can see here how the changelog file is invalid, making tools unable to read it correctly. https://github.com/spatie/laravel-health/blob/main/CHANGELOG.md

It would be cool if the plugin could change the headers to the right one, so it can be used together with githubs auto changelog feature 👍

The main idea behind this CLI, is to use it in the context of GitHub Actions. There are ways to generate the current date in the right format in Actions, but its 10x easier to do in PHP.

Updates the CLI to support new GITHUB_OUTPUT environment to declare output variables.

Fixes https://github.com/stefanzweifel/changelog-updater-action/issues/25

This PR adds a new --heading-text option to change the text of the release heading (currently defaults to the value of --latest-version).

This change allows users to pass an arbitrary value as the heading, if they don't want to use the tag name as the heading name.

Related issues

• https://github.com/stefanzweifel/changelog-updater-action/issues/19

This PR adds a new internal Action to Shift headings contained in the incoming release notes to be at least level 3 headings.

For example, the following release notes markdown …

## Added
- New Feature A

## Changed
- Update Feature C

## Removes
- Remove Feature D

is converted to this:

### Added
- New Feature A
- New Feature B

### Changed
- Update Feature C

### Removes
- Remove Feature D

The PR currently only shifts headings below level 3 (H1 and H2). This breaks the hierarchy, if for example H3 headings are also present in the release notes. Still figuring out, if it would make sense to shift all headings automatically.

refs #22

Fixes an issue where the CLI silently failed when the release notes could not be placed due to a missing child in the parsed Markdown AST – eg. the CHANGELOG file is empty.

This PR adds a new ExtractPermalinkFragmentFromHeading-action. It generates/extracts the URL fragment of the given heading, so that the consumer of the CLI/Action can generate an URL to point directly to the created release.

The Action:

• attaches a heading permalink to the given given heading
• renders the heading to HTML
• extracts the href-value
• outputs the value for GitHub Actions as RELEASE_URL_FRAGMENT

fixes https://github.com/stefanzweifel/changelog-updater-action/issues/13.

Instead of using is_null() to detect empty release notes, we now use empty(). The Action itself always passed the option but only changes the value from a string to an empty string "".

See https://github.com/stefanzweifel/changelog-updater-action/issues/12#issuecomment-1073115279.

This PR addresses the issue raised in https://github.com/stefanzweifel/changelog-updater-action/issues/14. If enabled through the --github-actions-output=true option, the CLI will create GitHub Actions output variables.

The values are:

• RELEASE_COMPARE_URL: The compare URL between the previous and latest release (eg. https://github.com/org/repo/compare/v0.1.0...v1.0.0)
• UNRELEASED_COMPARE_URL: The compare URL between the latest release and the target revision (eg. https://github.com/org/repo/compare/v1.0.0...HEAD)

Have not tested yet, if this actually works in GitHub Actions.

I think the use of Illuminate\Support\MessageBag in the GitHubActionsOutput-singleton is pretty smart, as we can reuse the powerful MessageBag-component from Laravel. 🏄

Related Issues

• https://github.com/stefanzweifel/changelog-updater-action/issues/14

This PR addresses the issue raised in https://github.com/stefanzweifel/changelog-updater-action/issues/12. It makes the --release-notes option optional. If no release notes have been given, a new release heading is placed directly after the Unreleased heading.

Releated Issues

• https://github.com/stefanzweifel/changelog-updater-action/issues/12

TODOs

• [x] Update PasteReleaseNotesAtTheTop

This PR updates the CLI to no longer add release notes to a changelog, if the given version already exists in the changelog. Instead a warning is displayed.

"CHANGELOG was not updated as release notes for {$release} already exist."