Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

automatically update changelog.md #495

Open
ITCTOM opened this issue Sep 6, 2024 · 3 comments
Open

automatically update changelog.md #495

ITCTOM opened this issue Sep 6, 2024 · 3 comments
Labels
question The issue is a question.

Comments

@ITCTOM
Copy link

ITCTOM commented Sep 6, 2024

Is it possible to update the changelog.md file automatically based on Commit messages or have i to write this file manually?

@LarryWisherMan
Copy link

Sampler doesn't have any built-in task to do this. I've played around with the idea by using conventual commits and then creating a custom invoke-build task. I haven't used it much, but this is what I had laying around

You would need to either run locally to satisfy the default QA Changelog Management test or disable that test in the build.yaml and you could run in the CI/CD

@johlju
Copy link
Collaborator

johlju commented Sep 10, 2024

The CHANGELOG.md is also used as the release notes in the module manifest when deploying a module, so the commit messages should probably be more descriptive that what a commit messages normally need to be (depending on commit style).

But a build tasks should probably work for this and excluding the tag Changelog so the QA test don't run. I would have made a task similar to @LarryWisherMan that runs for the build phase so release notes are correctly generated. Then have a pipeline trigger on PR merge to main that is running that task again and creating a PR to update CHANGELOG.md. 🤔

@johlju johlju added the question The issue is a question. label Sep 10, 2024
@ITCTOM
Copy link
Author

ITCTOM commented Sep 13, 2024

thx a lot I will try a own task to do this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question The issue is a question.
Projects
None yet
Development

No branches or pull requests

3 participants