Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 8 commits into from
Apr 25, 2024
Merged

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

merged 8 commits into from
Apr 25, 2024

Conversation

ni-jfitzger
Copy link
Collaborator

@ni-jfitzger ni-jfitzger commented Apr 22, 2024 •
edited
Loading

  • 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

@ni-jfitzger ni-jfitzger marked this pull request as ready for review April 25, 2024 15:56
@ni-jfitzger ni-jfitzger merged commit cfafd02 into ni:master Apr 25, 2024
35 checks passed
@ni-jfitzger ni-jfitzger deleted the add-release-process-to-CONTRIBUTING.md branch April 25, 2024 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marcoskirsch marcoskirsch marcoskirsch approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ni-jfitzger @marcoskirsch