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

feat(action): changelog/update - Update CHANGELOG.md with new version

Open
#38 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 W5/W6

Description

Create a composite action that updates a CHANGELOG.md file with a new version section.

Inputs

Input Required Default Description
changelog-path Yes - Path to CHANGELOG.md
version Yes - Version number
content Yes - Changelog content to insert
date No today Release date (YYYY-MM-DD)
create-if-missing No true Create file if it doesn't exist

Outputs

Output Description
updated "true" if file was modified
created "true" if file was created

Usage Example

- uses: arustydev/gha/actions/changelog/generate@v1
  id: gen

- uses: arustydev/gha/actions/changelog/update@v1
  with:
    changelog-path: charts/my-chart/CHANGELOG.md
    version: "1.3.0"
    content: ${{ steps.gen.outputs.changelog }}

Implementation Notes

  • Inserts new version section after header
  • Creates Keep-a-Changelog format file if missing
  • Preserves existing content
  • Handles [Unreleased] section if present

Source Reference

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

  • generate_changelog() - file creation and update logic

Related

  • #35 - changelog/extract-version (complementary)
  • #36 - changelog/generate (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.