Document release process in CONTRIBUTING.md and make it slightly easier - Githubissues

ni / nimi-python

Python bindings for NI Modular Instrument drivers.

Other

112 stars 84 forks source link

Document release process in CONTRIBUTING.md and make it slightly easier #2050

Closed ni-jfitzger closed 4 months ago

ni-jfitzger commented 4 months ago

[X] This contribution adheres to CONTRIBUTING.md.
[ ] ~I've updated CHANGELOG.md if applicable.~
[ ] ~I've added tests applicable for this pull request~

What does this Pull Request accomplish?

Handle updating LATEST_RELEASE in updateReleaseInfo.py
- One less manual step
Document Release Process in CONTRIBUTING.md, rather than a tool
- Tweak instructions, while we're at it
- Split steps into 3 clear stages: Pre-Release, Release, Post-Release
- Add a new first step: "Checkout the master branch and pull down the latest changes"
- Add commands for "Build master to ensure it is in a good state and ready for release"
- Update to reflect "LATEST_RELEASE" being handled by python3 tools/build_release.py --update --release
- Rearranged bullets so that each step has a description above the command

List issues fixed by this Pull Request below, if any.

None

What testing has been done?

Tested the updateReleaseInfo.py changes