Table of contents
Outputs and Commit Groups
Outputs
The action produces two outputs:
| Output | Description |
|---|---|
changelog |
The generated changelog as Markdown. |
version |
The tag the changelog was generated for. |
Use them in later steps with ${{ steps.<id>.outputs.changelog }} and ${{ steps.<id>.outputs.version }}:
- name: Generate changelog
id: changelog
uses: https://vc.maxkaya.com/maxpeterkaya/changelog@latest
with:
server_url: https://vc.maxkaya.com
repository: ${{ github.repository }}
token: ${{ secrets.PAT }}
- name: Show version
run: echo "Released ${{ steps.changelog.outputs.version }}"
When you run the binary or container outside Actions and GITHUB_OUTPUT is not set, outputs are printed to stdout as key=value lines instead.
Commit groups
The conventional style groups commits by their Conventional Commit prefix. Each prefix becomes a section in the changelog:
| Prefix | Section |
|---|---|
feat |
New Features |
fix |
Bug Fixes |
refactor |
Refactors |
deps |
Dependencies |
docs |
Documentation |
style |
Styles |
test |
Tests |
chore |
Chores |
| anything else | Other Work |
A scope and a breaking-change marker are accepted, so feat(api): ..., fix!: ..., and feat(ui)!: ... all match their prefix. Each entry links the short commit SHA and credits the author, for example:
- [a1b2c](https://vc.maxkaya.com/owner/repo/commit/...) : Added dark mode (@author)
The detailed and summary styles use the same groups but render prose instead of bullets. See Styles and LLM Providers.
Home · Installation · Inputs Reference · Tag Ranges and Rollup · Writing Changelogs to the Repository · Styles and LLM Providers · Troubleshooting