search

villano-lab / nrCascadeSim

calculating the NR spectrum resulting from neutron-capture cascades.
MIT License
0 stars 1 forks source link

Document how to do release for software team #34

Closed villaa closed 2 years ago

villaa commented 2 years ago

The release can be done through PR as well--but some steps need to be completed on the releaser's local copy and pushed.

  1. locally use git flow start release X.X.X to open a release branch.
  2. update the RELEASENOTES.md document and push branch to GitHub
  3. create a PR that has a base branch of master of the branch and document all the changes in the PR comment.
  4. if the checks pass and we're happy with the release, merge the PR
  5. On the local copy do git flow finish release X.X.X
  6. push the local copy of develop
  7. push the version numbers
  8. download a tar.gz and update the Zenodo entry with the new version.
villaa commented 2 years ago

Just found out that we should probably merge the release on the local side BEFORE merging the PR on Github, unless there is some way to merge a PR on github to two branches.

Basically the gitflow protocol is to merge the release to both master and develop, right? so just making the base branch on master is not sufficient.

villaa commented 2 years ago

I think it works best to do the merge on the local side after merging the PR but before deleting the branch on GitHub. The git flow finish command will delete the branch on the local and remote. So: