search

jscutlery / semver

Nx plugin to automate semantic versioning and CHANGELOG generation.
MIT License
727 stars 84 forks source link

add --skip-commit flag or option to debug CHANGELOGS #539

Open shairez opened 2 years ago

shairez commented 2 years ago

Without having to revert the commits everytime

Good options for new projects or newcomers

edbzn commented 2 years ago

Hi @shairez, we have the --dryRun option that just logs into the console but it does not display any changelog content as semver can generate multiple changelogs in the same round (in sync mode), which would be unreadable in the console.

shairez commented 2 years ago

Yeah I couldn't see the output with dryRun that's why I suggested this

I don't mind generating the files, just don't want to automcatically commit them or maybe even tag them (in case of a mistake)

I want to be able to debug or change stuff and maybe get a console.log that shows me the git command I need to run afterwards with the right commit mesage

But that's not a critical thing, so if you don't feel it's necessary just close this issue (really, no hard feelings 😘😊)

edbzn commented 2 years ago

Oh no, I don't take this as a criticism, I like the idea! I'm wondering how we can make this.

shairez commented 2 years ago

I know you buddy, I didn't mean to imply you took it the wrong way ❤

I just won't have time to dive deeper into the code now, so I said that if it brings you guys a headache, we can park it for now :)

Chowarmaan commented 2 years ago

Could this be addressed by adding a flag to simply generate the different change logs, maybe something like --onlyWriteProjectChangelog?

I would like to be able to generate the CHANGELOG.md so that I can edit it, and commit it into the branch before it is tagged with the new build. Ideally, I want to do what the -dry-run does, except just write the change log data. This is to allow the tag in my GIT repository to be have the CHANGELOG.md be what is in the code released with this generated tag. I want to be able to edit the CHANGELOG.md instead of just using the one generated, so I can clean up text, etc., that was written by the team.

DmitryEfimenko commented 4 months ago

you know an editor pops up when you do git commit. In the editor you have an option to customize commit message.

It'd be great if there was a similar feature where an editor pops up with generated contents of the CHANGELOG. And you have an ability to modify it. Once editor is closed, the changes are committed and a tagged.

The flag could be something like --interactive-changelog true