Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

feat(action): changelog/generate - Generate changelog from commits

Open
#37 0 comments 0 reactions 1 assignee View on GitHub

@aRustyDev is already working on this.

Since Jan 27, 2026.

Assessment

This issue has not been assessed yet.

Description

enhancement new-action

Parent Epic

Part of #22 (Atomic Release Pipeline Actions)

Priority

P1 - Release support for W6

Description

Create a composite action that generates changelog entries from conventional commits using git-cliff.

Inputs

Input Required Default Description
artifact Yes - Artifact name
artifact-path Yes - Path to artifacts directory
version Yes - Version for the changelog entry
base-ref No origin/main Base ref for commit range
config No cliff.toml Path to git-cliff config
output-format No markdown Output format: markdown, json

Outputs

Output Description
changelog Generated changelog content
commits-analyzed Number of commits analyzed

Usage Example

- uses: arustydev/gha/actions/changelog/generate@v1
  id: changelog
  with:
    artifact: my-chart
    artifact-path: charts
    version: "1.3.0"
    
- run: echo "${{ steps.changelog.outputs.changelog }}"

Implementation Notes

  • Uses git-cliff for changelog generation
  • Filters commits by artifact path
  • Supports custom git-cliff configuration
  • Falls back to simple commit list if git-cliff fails

Source Reference

helm-charts/.github/scripts/version-bump.sh:

  • generate_changelog() (lines 159-226)

Related

  • #13 - changelog generation (consolidate)
  • #35 - changelog/extract-version (complementary)
Dominant language
Shell
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from aRustyDev/gh

All issues in aRustyDev/gh

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.