Skip to content

Automate Changelog Generation #1

@mozrin

Description

@mozrin

We need to automate the generation of changelogs for each release to ensure consistency and reduce manual effort. The changelog should be automatically updated whenever a new release is triggered (major, minor, hotfix, or nightly).

Requirements:

Parse commit messages and/or PR titles since the last tag.

Group entries by type (e.g., Features, Fixes, Docs, Chores).

Update a CHANGELOG.md file in the root of the repo.

Include release version and date at the top of each section.

Integrate with the release workflow (release.yml) so changelog updates happen automatically before tagging.

Support a --dry-run mode to preview changelog output without committing.

Ensure changelog updates are committed back to the repo as part of the release process.

Acceptance Criteria:

On running release minor, release major, or release hotfix, the changelog is updated with the new version section.

Nightly builds append entries under a “Nightly Builds” section.

The changelog format follows Keep a Changelog style for readability.

Manual edits remain possible, but automation handles the bulk of updates.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions