search

coverlet-coverage / coverlet

Cross platform code coverage for .NET
MIT License
2.93k stars 385 forks source link

Generate CHANGELOG.md using changelog-from-release tool #1579

Closed Bertk closed 3 months ago

Bertk commented 5 months ago

The CHANGELOG.md can be generated using available tools and should be updated within the PR. This might require addition conventions for PR and git commits.

There are many tools and my favored for coverlet is [changelog-from-release]. I created a CHANGELOG.md for coverlet with this tools (see attachment) with command changelog-from-release -r https://github.com/coverlet-coverage/coverlet.

Proposal: Create GitHub action which created CHANGELOG.md and upload the file as build artifact. This can be used for release activity or using draft releases even for PR.

@daveMueller @MarcoRossignoli Please share your thoughts on this topic .

CHANGELOG.md

see also:

Draft release is updated every time the pipeline with the release-drafter action is called. 🚀

image
MarcoRossignoli commented 5 months ago

looks interesting, @daveMueller what you think?

daveMueller commented 5 months ago

Nothing against that. As long as it is just release-drafter and changelog-from-release and I don't need to look into additional tools to fix something when it breaks. What I think is a bit annoying that you need changelog-from-release to create the markdown as release-drafter doesn't have a option to also create it. What I'm also missing a bit is the option to manually add something to the markdown, e.g. description of breaking changes etc... Do I then need to update the draft release first with my manual information so that it is included in the changelog?

Bertk commented 5 months ago

Yes, the (draft) release information will be the source for CHANGELOG.md. release-drafter will create information which can be used and modified/extended but the information depends on the correct labeling.

Maybe we can just active release-drafter draft now and changelog-from-release as the next step.

changelog-from-release will update the format of CHANGELOG.md and the current template is not using e.g. a preamble. The existing coverlet releases need also updates to resolve markdown format issues. By the way, I can not modify the coverlet release information.

image