1
0
mirror of https://github.com/djhackersdev/bemanitools.git synced 2024-11-28 00:10:51 +01:00
bemanitools/doc/release-process.md
icex2 389708f794 chore(doc): Documentation cleanup and improvements
- Add index with aux tooling to main readme
- Move release process to doc, not valuable to have this on the
  main readme
2023-04-06 15:39:53 +02:00

1.5 KiB

Release process

For bemanitools maintainers, steps for the release process:

  1. Update the corresponding section in the changelog with bullet points reflecting major features merged into master since the previous release

  2. Make sure you have the latest master state pulled to your local copy

  3. Tag the release with the next release number which also be found at the top of the readme as it always reflects the current version beinged worked on on the master branch , e.g. 5.35: git tag 5.35

  4. Push the tag to upstream: git push origin 5.35

  5. The build pipeline should start automatically once the tag is pushed including the steps build and upload-release

  6. Once completed successfully, the release is uploaded

  7. Take the changelog of the published version and notify the pigs in the stall about it:

    1. New post in thread
      <insert version here> released: <direct link to published version>
      
      Changelog:
      <paste changelog here>
      
    2. Update the OP title by bumping the version number in it
    3. Update the OP post by extending it accordingly (see previous entries)
  8. Bump the version number at the top of this readme and add a new empty section in the changelog with the new version number as title. Commit changes and push to master branch

  9. Continue developing and merging MRs until you decide its time for another release