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

Documentation: Update Release Guide to create the main_vX.Y branch for the first release candidate #2754

Open
8 of 23 tasks
JohnHalleyGotway opened this issue Oct 28, 2024 · 0 comments · May be fixed by #2755
Open
8 of 23 tasks
Assignees
Labels
component: documentation Documentation issue priority: medium Medium Priority reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project requestor: METplus Team METplus Development Team type: task An actionable item of work
Milestone

Comments

@JohnHalleyGotway
Copy link
Collaborator

Describe the Task

As discussed via Slack and during METplus project meetings, update the instructions in METplus Release Guide to create the main_vX.Y branches prior to the first release candidate rather than waiting for the official release. This change frees up the develop branch to accept new changes for future releases rather than needing to keep it locked down until the official release date.

The downside is that changes between RC1 and the final official release will need to be made to both the main_vX.Y branch and the develop branch.

Time Estimate

2 hours

Sub-Issues

Consider breaking the task down into sub-issues.
None needed

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

DTC NOAA Base (2782544) for software release support

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required
  • Select scientist(s) or no scientist required

Labels

  • Review default alert labels
  • Select component(s)
  • Select priority
  • Select requestor(s)

Milestone and Projects

  • Select Milestone as a METplus-Wrappers-X.Y.Z version, Consider for Next Release, or Backlog of Development Ideas
  • For a METplus-Wrappers-X.Y.Z version, select the METplus-Wrappers-X.Y.Z Development project

Define Related Issue(s)

Consider the impact to the other METplus components.

Task Checklist

See the METplus Workflow for details.

  • Complete the issue definition above, including the Time Estimate and Funding Source.
  • Fork this repository or create a branch of develop.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the development and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Add any new Python packages to the METplus Components Python Requirements table.
  • For any new datasets, an entry to the METplus Verification Datasets Guide.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop.
    Pull request: feature <Issue Number> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Development issue
    Select: Milestone as the next official version
    Select: METplus-Wrappers-X.Y.Z Development project for development toward the next official release
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@JohnHalleyGotway JohnHalleyGotway added component: documentation Documentation issue priority: medium Medium Priority type: task An actionable item of work reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project requestor: METplus Team METplus Development Team labels Oct 28, 2024
@JohnHalleyGotway JohnHalleyGotway added this to the METplus-6.0.0 milestone Oct 28, 2024
@JohnHalleyGotway JohnHalleyGotway self-assigned this Oct 28, 2024
JohnHalleyGotway added a commit that referenced this issue Oct 28, 2024
…ref branches (when applicable) for the first release candidate rather than waiting until the official release. Note that I deleted the push_release_branch.rst instructions since it's not needed. The preceeding instructions execute the push and these are redundant - even for METplus which has custom instructions.
@JohnHalleyGotway JohnHalleyGotway linked a pull request Oct 28, 2024 that will close this issue
16 tasks
JohnHalleyGotway added a commit that referenced this issue Oct 29, 2024
…h the names of the actual fields on GitHub.
JohnHalleyGotway added a commit that referenced this issue Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issue priority: medium Medium Priority reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project requestor: METplus Team METplus Development Team type: task An actionable item of work
Projects
Status: 🔎 In review
Development

Successfully merging a pull request may close this issue.

1 participant