gaelcolas / Sampler

Module template with build pipeline and examples, including DSC elements.
MIT License
171 stars 42 forks source link

automatically update changelog.md #495

Open ITCTOM opened 2 months ago

ITCTOM commented 2 months ago

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

LarryWisherMan commented 2 months ago

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 commented 2 months ago

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. 🤔

ITCTOM commented 2 months ago

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