semantic-release / changelog

:blue_book: semantic-release plugin to create or update a changelog file
MIT License
304 stars 28 forks source link

Changelog Generation as Artifact of Pipeline Execution #391

Open pmsmm opened 5 months ago

pmsmm commented 5 months ago

Hello everyone and apologies if this issue is a consequence of me not finding the proper documentation but I've searched quite a lot.

Basically I'm in the process of generating a CHANGELOG.md file so that I can send that file off to someone else. I've read in the FAQ that commiting a changelog to the repository introduces some complexities that should be avoided when possible.

Given this I've been attempting, so far to no success, to generate the changelog and save it as an artifact of my pipeline so that I can then manually retrieve it and send it to the desired person.

Is this something that can actually be done with the changelog plugin or is the only way of achieving this through commiting the changelog file to the repository? If this is actually possible then my suggestion would be to add an example to the documentation just as a heads up to people that want to avoid the added complexity of commiting these files back onto the repository.

Just a heads up, our current workflow implies copying the release notes generated during dry-run and then sending them off somewhere, what we intend to achieve is to just get a simple file (CHANGELOG.md) and send it to someone.

Thanks in advance