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

Feature #2735 v6.0.0 beta6 #2736

Merged
merged 9 commits into from
Oct 18, 2024
Merged

Feature #2735 v6.0.0 beta6 #2736

merged 9 commits into from
Oct 18, 2024

Conversation

georgemccabe
Copy link
Collaborator

@georgemccabe georgemccabe commented Oct 18, 2024

Besides adding the release notes and updating the version file, I added:

  • A script to help generate release notes and entries to the release acceptance testing discussion
  • Added/updated issue templates to include default titles and added Documentation issue template so issues can more easily be parsed by release notes script

Review release notes here:
https://metplus--2736.org.readthedocs.build/en/2736/Users_Guide/release-notes.html

@georgemccabe georgemccabe added this to the METplus-6.0.0 milestone Oct 18, 2024
@georgemccabe georgemccabe added the component: release engineering Release engineering issue label Oct 18, 2024
@georgemccabe georgemccabe linked an issue Oct 18, 2024 that may be closed by this pull request
@georgemccabe georgemccabe marked this pull request as ready for review October 18, 2024 18:07
@JohnHalleyGotway JohnHalleyGotway requested review from JohnHalleyGotway and removed request for jprestop October 18, 2024 18:32
Copy link
Collaborator

@JohnHalleyGotway JohnHalleyGotway left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In principle, I approve of these changes, but did make a few suggestions on the PR for your consideration, along with this:

  • Consider using Task for task template issues instead of Internal to avoid confusion.
  • I note that none of the release notes are bolded. Please review and use your judgement to highlight any that should be emphasized.
  • I reviewed the rendered release notes and like how you've set the script up to strip the prefix off of the issue title.
    • This is very subjective, but I always reword to the bugfix issues to state: "Fix {ABC} to do {XYZ}". Otherwise, we end up with a lot of variability in how info is communicated. Up to your discretion though.
  • Reminder that issue templates only take effect when in the default branch. So you may want to make the same changes in main_v5.1 or consider switching to using develop as the default branch.
  • Recommend updating the Release Guide instructions for writing release notes to point to the new utility script, along with debugging issues running it on seneca.

…ut version is a beta or rc version to preserve previous behavior of GHA scripts. Update GHA scripts to use new option
@georgemccabe georgemccabe merged commit 5ba60f7 into develop Oct 18, 2024
68 checks passed
@georgemccabe georgemccabe deleted the feature_2735_v6.0.0-beta6 branch October 18, 2024 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: release engineering Release engineering issue
Projects
Status: 🏁 Done
Development

Successfully merging this pull request may close these issues.

Create the METplus v6.0.0-beta6 release
2 participants