Skip to content

Add CHANGELOG.md to Repository -- Currently Only Generated in CI #326

Description

@ALLEN-AYODEJI

Add CHANGELOG.md to Repository -- Currently Only Generated in CI

Description

Changelog is generated by git-cliff in CI during release but not committed to the repository. Users browsing the repo cannot see release history. CHANGELOG.md should be maintained as a committed file.

Requirements & Context

Generate initial CHANGELOG.md from git history. Add to repo. Add Makefile target for regeneration. Add release.yml step to commit updated changelog.

Suggested Execution

Branch: eat/docs-changelog

Implement Changes

(1) Run git-cliff to generate CHANGELOG.md (2) Add to repository (3) Add Makefile target (4) Add release workflow step to update changelog

Test & Commit

Run git-cliff, verify CHANGELOG.md is generated correctly.

Example Commit Message

eat(docs): add CHANGELOG.md to repository for accessible release history

Guidelines

  • Generate from git history using cliff.toml config
  • Commit changelog as part of release process

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions