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.

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

More updates to release process documentation #209

Merged

Conversation

robertbartel
Copy link
Contributor

Making a few more changes to release process documentation to reflect some unique properties of this particular repo.

Changes

  • Change how release candidate branch is name to reflect time rather than convoluted combination of package versions
  • Change order of events in release process, since new version(s) doesn't have to happen before creating the release candidate branch now
  • Change steps for the version(s) incrementing to more completely cover the actual process, given the multiple packages that may depend on each other
  • Change the step describing applying tags, since the packages and their versions are what matter
  • Change discussion of how versions are incremented and such
  • Adding a suggestion to use development versions (aligned with Semantic Versioning) to reflect dependency changes during development that will eventually necessitate version increments
  • Changing official version tag format to reflect format of existing tags

Checklist

  • PR has an informative and human-readable title
  • Changes are limited to a single goal (no scope creep)
  • Code can be automatically merged (no conflicts)
  • Code follows project standards (link if applicable)
  • Passes all existing automated tests
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future todos are captured in comments
  • Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
  • Reviewers requested with the Reviewers tool ➡️

Updating to reflect uniqueness of this repo and some modifications to
the release process that are necessary because of that; also updating
tagging format to align with tags that already exist.
@robertbartel robertbartel added documentation Improvements or additions to documentation QA/QC labels Oct 11, 2024
@christophertubbs christophertubbs merged commit 218e303 into NOAA-OWP:master Oct 16, 2024
15 of 16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation QA/QC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants