Feature 2346 main v5.1 update templates #2588

jprestop · 2024-05-15T23:51:37Z

Pull Request Testing

Describe testing already performed for these changes:

Reviewed the changes. These changes are based off of the work from this MET issue to improve the issue and pull request templates.
Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:

Review the changes.
Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes]
Do these changes include sufficient testing updates? [None needed]
Will this PR result in changes to the test suite? [No]

If yes, describe the new output and/or changes to the existing output:
Do these changes introduce new SonarQube findings? [No]

If yes, please describe:
Please complete this pull request review by [20240520].

Pull Request Checklist

Add any new Python packages to the METplus Components Python Requirements table.
Review the source issue metadata (required labels, projects, and milestone).
Complete the PR definition above.
Ensure the PR title matches the feature or bugfix branch name.
Define the PR metadata, as permissions allow.
Select: Reviewer(s)
Select: Organization level software support Project or Repository level development cycle Project
Select: Milestone as the version that will include these changes
After submitting the PR, select the ⚙️ icon in the Development section of the right hand sidebar. Search for the issue that this PR will close and select it, if it is not already selected.
After the PR is approved, merge your changes. If permissions do not allow this, request that the reviewer do the merge.
Close the linked issue and delete your feature or bugfix branch from GitHub.

georgemccabe

I made a few in-line suggestions. I recommend cherry-picking the commits of the changes you decide to make in this PR to apply them to the corresponding develop branch PR #2589

georgemccabe · 2024-05-16T14:26:08Z

.github/ISSUE_TEMPLATE/enhancement_request.md

- [ ] Select **Repository** and/or **Organization** level **Project(s)** or add **alert: NEED CYCLE ASSIGNMENT** label
- [ ] Select **Milestone** as the next official version or **Future Versions**
+### Milestone and Projects ###
+- [ ] Select **Milestone** as the next official version or **Backlog of Development Ideas**


Suggested change

- [ ] Select **Milestone** as the next official version or **Backlog of Development Ideas**

- [ ] Select **Milestone** as the next official version, **Consider for Next Release**, or **Backlog of Development Ideas**

georgemccabe · 2024-05-16T14:27:25Z

.github/ISSUE_TEMPLATE/bug_report.md

@@ -65,20 +67,22 @@ Branch name: `bugfix_<Issue Number>_main_<Version>_<Description>`
 - [ ] 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](https://metplus.readthedocs.io/en/develop/Users_Guide/overview.html#metplus-components-python-requirements) table.
+- [ ] Add any new Python packages to the [METplus Components Python Requirements](https://metplus.readthedocs.io/en/develop/Users_Guide/appendixA.html#metplus-components-python-packages) table.
+- [ ] For any new datasets, an entry to the [METplus Verification Datasets Guide](https://metplus.readthedocs.io/en/latest/Verification_Datasets/index.html).


This may not be necessary for a bugfix issue since a fix to existing functionality is unlikely to add new datasets.

Suggested change

- [ ] For any new datasets, an entry to the [METplus Verification Datasets Guide](https://metplus.readthedocs.io/en/latest/Verification_Datasets/index.html).

@georgemccabe I thought the same thing at first, but then I thought there could be a case where the bug would have been discovered due to a new dataset. Please confirm if you'd prefer I take this out or leave it in. Thanks!

I think the new dataset would be added with a different issue. If a bug was discovered, a new issue would be created to address the bug that is separate.

Given your comment, it sounds like you would prefer that I remove it, so I will do that. Please let me know if I misunderstood.

georgemccabe · 2024-05-16T14:28:18Z

.github/ISSUE_TEMPLATE/new_feature_request.md

- [ ] Select **Repository** and/or **Organization** level **Project(s)** or add **alert: NEED CYCLE ASSIGNMENT** label
- [ ] Select **Milestone** as the next official version or **Future Versions**
+### Milestone and Projects ###
+- [ ] Select **Milestone** as the next official version or **Backlog of Development Ideas**


Suggested change

- [ ] Select **Milestone** as the next official version or **Backlog of Development Ideas**

- [ ] Select **Milestone** as the next official version, **Consider for Next Release**, or **Backlog of Development Ideas**

georgemccabe · 2024-05-16T14:28:54Z

.github/ISSUE_TEMPLATE/new_use_case.md

- [ ] Select **Repository** and/or **Organization** level **Project(s)** or add **alert: NEED CYCLE ASSIGNMENT** label
- [ ] Select **Milestone** as the next official version or **Future Versions**
+### Milestone and Projects ###
+- [ ] Select **Milestone** as the next official version or **Backlog of Development Ideas**


Suggested change

- [ ] Select **Milestone** as the next official version or **Backlog of Development Ideas**

- [ ] Select **Milestone** as the next official version, **Consider for Next Release**, or **Backlog of Development Ideas**

georgemccabe · 2024-05-16T14:29:36Z

.github/ISSUE_TEMPLATE/sub-issue.md

- [ ] Select **Repository** and/or **Organization** level **Project(s)** or add **alert: NEED CYCLE ASSIGNMENT** label
- [ ] Select **Milestone** as the next official version or **Future Versions**
+### Milestone and Projects ###
+- [ ] Select **Milestone** as the next official version or **Backlog of Development Ideas**


Suggested change

- [ ] Select **Milestone** as the next official version or **Backlog of Development Ideas**

- [ ] Select **Milestone** as the next official version, **Consider for Next Release**, or **Backlog of Development Ideas**

georgemccabe · 2024-05-16T14:29:54Z

.github/ISSUE_TEMPLATE/task.md

- [ ] Select **Repository** and/or **Organization** level **Project(s)** or add **alert: NEED CYCLE ASSIGNMENT** label
- [ ] Select **Milestone** as the next official version or **Future Versions**
+### Milestone and Projects ###
+- [ ] Select **Milestone** as the next official version or **Backlog of Development Ideas**


Suggested change

- [ ] Select **Milestone** as the next official version or **Backlog of Development Ideas**

- [ ] Select **Milestone** as the next official version, **Consider for Next Release**, or **Backlog of Development Ideas**

georgemccabe · 2024-05-16T14:31:21Z

.github/ISSUE_TEMPLATE/update_truth.md

- [ ] Select **Repository** and/or **Organization** level **Project(s)** or add **alert: NEED CYCLE ASSIGNMENT** label
- [ ] Select **Milestone** as the next official version or **Future Versions**
+### Milestone and Projects ###
+- [ ] Select **Milestone** as the next official version or **Backlog of Development Ideas**


Updating the truth data should never be added to the backlog since it should be completed ASAP. If updating truth for an existing release, the bugfix milestone should be used instead.

Suggested change

- [ ] Select **Milestone** as the next official version or **Backlog of Development Ideas**

- [ ] Select **Milestone** as the next official version if updating truth data for the `develop` branch OR select next X.Y.Z bugfix version if updating truth data for a `main_vX.Y` branch

@georgemccabe Great point! Clearly I wasn't using my brain for this one!🤪

georgemccabe · 2024-05-16T14:35:06Z

.github/ISSUE_TEMPLATE/update_truth.md

- [ ] Select **Milestone** as the next official version or **Future Versions**
+### Milestone and Projects ###
+- [ ] Select **Milestone** as the next official version or **Backlog of Development Ideas**
+- [ ] For the next official version, select the **METplus-Wrappers-X.Y.Z Development** project


If the truth data is being updated for an existing release, then the coordinated release support project should be selected instead.

Suggested change

- [ ] For the next official version, select the **METplus-Wrappers-X.Y.Z Development** project

- [ ] If updating truth data for the `develop` branch, select the **METplus-Wrappers-X.Y.Z Development** project OR if updating truth for a `main_vX.Y` branch, select the **Coordinated METplus-X.Y Support** project

@georgemccabe

* added new use case that was missing * Bugfix #2279 main_v5.1 - buoy station file from 2022 (#2281) * Fix typo in pull_request_template.md * added notes to make it clear that upgrade instructions are not needed if upgrading from 5.0 to 5.1 * New issue template: Update Truth (#2332) Co-authored-by: John Halley Gotway <johnhg@ucar.edu> (cherry picked from commit 44335f3) * add GitHub Actions workflow that is used to create Docker images that hold the conda environment used for the automated tests -- adding this to the default main_v5.1 branch so that it will become available to run for other branches as a workflow_dispatch workflow * add argument to workflow dispatch event so that MET DockerHub repo used for tests can be easily overridden to test changes in a MET PR before merging * Feature dtcenter/MET#2796 main_v5.1 GHA Node20 deprecation warnings (#2474) * per dtcenter/MET#2796, update versions of actions to prevent deprecated node warnings in GHA runs - main_v5.1 * fix ReadTheDocs requirements to include pillow which is a dependency of sphinx-gallery: see https://blog.readthedocs.com/defaulting-latest-build-tools/ for more info on why this was necessary * install python packages via apk instead of pip to prevent GHA failures that were fixed in develop but not in main_v5.1 * per dtcenter/MET#2796, fix error log merging for main_v5.1 same as develop * Bump pillow from 10.0.1 to 10.2.0 in /docs (#2477) Bumps [pillow](https://github.com/python-pillow/Pillow) from 10.0.1 to 10.2.0. - [Release notes](https://github.com/python-pillow/Pillow/releases) - [Changelog](https://github.com/python-pillow/Pillow/blob/main/CHANGES.rst) - [Commits](python-pillow/Pillow@10.0.1...10.2.0) --- updated-dependencies: - dependency-name: pillow dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Create 5.1.0_casper * Update update_truth.md Fix typo in the update_truth issue template. * Update update_truth.md Clarify wording on the update_truth issue template. * Feature #2537 main_v5.1 sonarqube_gha (#2542) * Per #2537, add SonarQube workflow for METplus * Per #2537, update nightly build email list. * Per #2537, fix cut/paste error configure_sonarqube.sh * Per #2537, exclude test code from code coverage statistics. * update link to METplus Components Python Requirements table in PR template * update pillow version based on recommendation from dependabot: https://github.com/dtcenter/METplus/security/dependabot/5 * Fix main_v5.1 GHA - disk space and METviewer version (#2561) * added more commands to free up disk space as suggested in https://github.com/apache/flink/blob/master/tools/azure-pipelines/free_disk_space.sh, ci-run-all-cases * update location of METviewer docker-compose.yml file that moved from PR dtcenter/METviewer#525 * turn on use cases to test * use main_v5.1 tag of METviewer on DockerHub * turn off use case groups after confirming that they now run successfully * Feature #2537 main_v5.1 single_sq_project (#2559) * Feature 2346 main v5.1 update templates (#2588) * Per #2346, modifying issue templates * Per #2346, modifying the pull request template * Per #2346, modifying entries based on suggestions by @georgemccabe * Feature 2346 main v5.1 update templates (#2595) * Per #2346, modifying issue templates * Per #2346, modifying the pull request template * Per #2346, modifying entries based on suggestions by @georgemccabe * Per 2346, making updates based on feedback at last MET Eng. Meeting * fix broken link * Bump certifi from 2023.7.22 to 2024.7.4 (#2632) Bumps [certifi](https://github.com/certifi/python-certifi) from 2023.7.22 to 2024.7.4. - [Commits](certifi/python-certifi@2023.07.22...2024.07.04) --- updated-dependencies: - dependency-name: certifi dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * main_v5.1 - Enhance update truth data workflow to create a uniquely named branch... (#2678) * Enhance update truth data workflow to create a uniquely named branch to update *-ref branches and commit/append to a log file that tracks the reasons for updating the truth data. This is done to ensure that the *-ref branch testing workflow run that actually updates the truth data is always run even if there are no other changes to the METplus branch since the last update, e.g. when a change to another component like MET warrants the truth data update * git add change log file in case it doesn't already exist * changed logic to no longer push changes to develop/main_vX.Y, but instead merge changes from -ref into the update branch * retain update truth history file from *-ref * prevent failure when changelog does not exist in -ref branch * added entry to update truth change log: main_v5.1 dtcenter/MET#2960 --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com> Co-authored-by: John Halley Gotway <johnhg@ucar.edu> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Julie Prestopnik <jpresto@ucar.edu> Co-authored-by: metplus-bot <97135045+metplus-bot@users.noreply.github.com>

jprestop added 2 commits May 15, 2024 17:43

Per #2346, modifying issue templates

7a54800

Per #2346, modifying the pull request template

8c3ec30

jprestop added this to the METplus-5.1.1 Bugfix milestone May 15, 2024

jprestop requested a review from georgemccabe May 15, 2024 23:51

jprestop linked an issue May 15, 2024 that may be closed by this pull request

Update GitHub issue and pull request templates to reflect the current development workflow details #2346

Closed

21 tasks

georgemccabe requested changes May 16, 2024

View reviewed changes

Per #2346, modifying entries based on suggestions by @georgemccabe

430fad7

jprestop requested a review from georgemccabe May 16, 2024 16:08

georgemccabe approved these changes May 16, 2024

View reviewed changes

georgemccabe mentioned this pull request May 16, 2024

Feature 2346 develop update templates #2589

Merged

15 tasks

jprestop merged commit 4491124 into main_v5.1 May 16, 2024
2 checks passed

jprestop deleted the feature_2346_main_v5.1_update_templates branch May 16, 2024 19:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature 2346 main v5.1 update templates #2588

Feature 2346 main v5.1 update templates #2588

jprestop commented May 15, 2024

georgemccabe left a comment

georgemccabe May 16, 2024

georgemccabe May 16, 2024

jprestop May 16, 2024

georgemccabe May 16, 2024

jprestop May 16, 2024

georgemccabe May 16, 2024

georgemccabe May 16, 2024

georgemccabe May 16, 2024

georgemccabe May 16, 2024

georgemccabe May 16, 2024

jprestop May 16, 2024

georgemccabe May 16, 2024

	- [ ] Select Milestone as the next official version or Backlog of Development Ideas
	- [ ] Select Milestone as the next official version, Consider for Next Release, or Backlog of Development Ideas

	- [ ] For the next official version, select the METplus-Wrappers-X.Y.Z Development project
	- [ ] If updating truth data for the `develop` branch, select the METplus-Wrappers-X.Y.Z Development project OR if updating truth for a `main_vX.Y` branch, select the Coordinated METplus-X.Y Support project

Feature 2346 main v5.1 update templates #2588

Feature 2346 main v5.1 update templates #2588

Conversation

jprestop commented May 15, 2024

Pull Request Testing

Pull Request Checklist

georgemccabe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment