documentation for doing a release manually

aleksandr-m / gitflow-maven-plugin

The Git-Flow Maven Plugin supports various Git workflows, including GitFlow and GitHub Flow. This plugin runs Git and Maven commands from the command line.

https://aleksandr-m.github.io/gitflow-maven-plugin/

Apache License 2.0

488 stars 180 forks source link

documentation for doing a release manually #312

Open basisbit opened 2 years ago

basisbit commented 2 years ago

There are various common reasons why the plugin might fail, without it giving a helpful error message or how to continue. Thus, imho it would be very helpful to add some documentation in the README.md file on what which step does and what commands are needed to manually run it. Then users can copy & pasta them into shell after resolving a merge conflict or a faulty version number update or various other things.

aleksandr-m commented 2 years ago

It doesn't make sense to add this to the readme. Goal steps depend on the configuration. It would be great to have continue feature or at least print out commands to the console in case of failure, but it is not a trivial task to do so. Ideas / PR-s are welcome.