feat(meta 46): update CI to update CHANGELOG #4310
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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](https://private-user-images.githubusercontent.com/3059609/404453470-711f335b-058b-4189-b772-e1d184390d8a.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkyNjQ0MTMsIm5iZiI6MTczOTI2NDExMywicGF0aCI6Ii8zMDU5NjA5LzQwNDQ1MzQ3MC03MTFmMzM1Yi0wNThiLTQxODktYjc3Mi1lMWQxODQzOTBkOGEucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIxMSUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMTFUMDg1NTEzWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9NzhkYWNhYWI0YzBjZTNkN2Y4MDg1YWY4OWYxNTE2MTZhZTk0ZDc1ZDllYjYzODQxZmIzMDRhNjRjNzQ1ZTYyNSZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.4Y_rbxi_ddmpVbiREm4pa4FjFewM2J5tuaZGjdpzrTU)
Why:
Currently CHANGELOG.md maintenance is a manual effort which takes time and can be error prone.
Checklist:
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.