Skip to content

Conversation

puckowski
Copy link
Contributor

@puckowski puckowski commented Jan 14, 2025

What:

Important: this will require standardizing commit headers. See formatting notes here: https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular

Update Less.js GitHub CI with the capability to automatically update CHANGELOG.md on certain master pushes/PR merges.

Should resolve: less/less-meta#46

If a push or PR merge to master branch has a commit which has a header containing "Release v" the changelog CI will run and automatically commit changes to CHANGELOG.md.

Format:

On master push:
[commit header] ([commit hash])

On PR merge:
[commit header] ([PR link]) ([commit hash])

CHANGELOG.md sample:
image

Why:

Currently CHANGELOG.md maintenance is a manual effort which takes time and can be error prone.

Checklist:

  • Documentation
  • Added/updated unit tests
  • Code complete

Should preserve historical CHANGELOG.md contents created via different means.

We can tweak the change formatting by adding a new configuration file, I went with the default angular style that did not require adding a configuration file.

* Update GitHub CI to automatically update CHANGELOG.md on main PR or
  main push using conventional-changelog-cli.
@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Jan 14, 2025
@iChenLei
Copy link
Member

Coooool

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[TODO] Find an easier way to maintain or automate the changelog
2 participants