From 1ad7b5cd2b35d687a28c5fcbf867422cec155e47 Mon Sep 17 00:00:00 2001 From: Jeremy Frasier Date: Wed, 15 Feb 2023 15:00:54 -0500 Subject: [PATCH 1/7] Add cisagov's standard PR checklists to the Lineage templates This was triggered by the realization that one will likely need to bump the version and create a release after merging a Lineage PR for any versioned repositories. --- src/lineage/templates/clean_template.md | 34 +++++++++++++++++++ src/lineage/templates/conflict_template.md | 38 ++++++++++++++++++++-- 2 files changed, 69 insertions(+), 3 deletions(-) diff --git a/src/lineage/templates/clean_template.md b/src/lineage/templates/clean_template.md index fa3f592..0805d31 100644 --- a/src/lineage/templates/clean_template.md +++ b/src/lineage/templates/clean_template.md @@ -9,6 +9,40 @@ Upstream repository: [`{{ remote_url }}`]({{ remote_url }}) Check the changes in this pull request to ensure they won't cause issues with your project. +## ✅ Pre-approval checklist ## + + + + + + +- [ ] ✌️ The conflicts in this pull request have been resolved. +- [ ] Changes are limited to a single goal - *eschew scope creep!* +- [ ] *All* future TODOs are captured in issues, which are referenced + in code comments. +- [ ] All relevant type-of-change labels have been added. +- [ ] I have read the [CONTRIBUTING](../blob/develop/CONTRIBUTING.md) document. +- [ ] These code changes follow [cisagov code standards](https://github.com/cisagov/development-guide). +- [ ] All relevant repo and/or project documentation has been updated + to reflect the changes in this PR. +- [ ] Tests have been added and/or modified to cover the changes in this PR. +- [ ] All new and existing tests pass. + +## ✅ Pre-merge checklist ## + + + + + +- [ ] Bump version via the `bump_version.sh` script, if this + repository is versioned. + +## ✅ Post-merge checklist ## + + + +- [ ] Create a release. + --- **Note:** *You are seeing this because one of this repository's maintainers has diff --git a/src/lineage/templates/conflict_template.md b/src/lineage/templates/conflict_template.md index 03cae3a..a627354 100644 --- a/src/lineage/templates/conflict_template.md +++ b/src/lineage/templates/conflict_template.md @@ -50,12 +50,44 @@ that you must resolve before merging this pull request! 1. Wait for all the automated tests to pass. -1. Check the "Everything is cool" checkbox below: - - - [ ] ✌️ The conflicts in this pull request have been resolved. +1. Check the "Everything is cool" checkbox below. 1. Mark this draft pull request "Ready for review". +## ✅ Pre-approval checklist ## + + + + + + +- [ ] ✌️ The conflicts in this pull request have been resolved. +- [ ] Changes are limited to a single goal - *eschew scope creep!* +- [ ] *All* future TODOs are captured in issues, which are referenced + in code comments. +- [ ] All relevant type-of-change labels have been added. +- [ ] I have read the [CONTRIBUTING](../blob/develop/CONTRIBUTING.md) document. +- [ ] These code changes follow [cisagov code standards](https://github.com/cisagov/development-guide). +- [ ] All relevant repo and/or project documentation has been updated + to reflect the changes in this PR. +- [ ] Tests have been added and/or modified to cover the changes in this PR. +- [ ] All new and existing tests pass. + +## ✅ Pre-merge checklist ## + + + + + +- [ ] Bump version via the `bump_version.sh` script, if this + repository is versioned. + +## ✅ Post-merge checklist ## + + + +- [ ] Create a release. + --- **Note:** *You are seeing this because one of this repository's maintainers has From 2f5ee79851ed8b64619628b863039bb61cde4ecf Mon Sep 17 00:00:00 2001 From: Jeremy Frasier Date: Wed, 15 Feb 2023 15:06:24 -0500 Subject: [PATCH 2/7] Remove conflict resolution checkbox from clean template --- src/lineage/templates/clean_template.md | 1 - 1 file changed, 1 deletion(-) diff --git a/src/lineage/templates/clean_template.md b/src/lineage/templates/clean_template.md index 0805d31..90a23e6 100644 --- a/src/lineage/templates/clean_template.md +++ b/src/lineage/templates/clean_template.md @@ -16,7 +16,6 @@ your project. -- [ ] ✌️ The conflicts in this pull request have been resolved. - [ ] Changes are limited to a single goal - *eschew scope creep!* - [ ] *All* future TODOs are captured in issues, which are referenced in code comments. From 2385e9c73f278a3fea7cefa38d96a3fc4678e685 Mon Sep 17 00:00:00 2001 From: Jeremy Frasier Date: Wed, 15 Feb 2023 15:06:50 -0500 Subject: [PATCH 3/7] Bump version from 0.2.0 to 0.2.1 --- src/lineage/_version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/lineage/_version.py b/src/lineage/_version.py index 6baaa6f..786a5cc 100644 --- a/src/lineage/_version.py +++ b/src/lineage/_version.py @@ -1,2 +1,2 @@ """This file defines the version of this module.""" -__version__ = "0.2.0" +__version__ = "0.2.1" From 4add5aad4172ee52b6325bf99552515b2ae9e943 Mon Sep 17 00:00:00 2001 From: Shane Frasier Date: Wed, 15 Feb 2023 16:44:58 -0500 Subject: [PATCH 4/7] Elaborate on checkbox portion of instructions Co-authored-by: dav3r --- src/lineage/templates/conflict_template.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/lineage/templates/conflict_template.md b/src/lineage/templates/conflict_template.md index a627354..eb56650 100644 --- a/src/lineage/templates/conflict_template.md +++ b/src/lineage/templates/conflict_template.md @@ -50,7 +50,11 @@ that you must resolve before merging this pull request! 1. Wait for all the automated tests to pass. -1. Check the "Everything is cool" checkbox below. +1. Confirm each item in the "Pre-approval checklist" below. + +1. Remove any of the checklist items that do not apply. + +1. Ensure every remaining checkbox has been checked. 1. Mark this draft pull request "Ready for review". From 8feb26b1a7dd60c6d218548984c6ca1849b4583a Mon Sep 17 00:00:00 2001 From: Shane Frasier Date: Wed, 15 Feb 2023 16:46:13 -0500 Subject: [PATCH 5/7] Move helper statements out of comments and into the light Co-authored-by: dav3r --- src/lineage/templates/clean_template.md | 13 +++++-------- src/lineage/templates/conflict_template.md | 13 +++++-------- 2 files changed, 10 insertions(+), 16 deletions(-) diff --git a/src/lineage/templates/clean_template.md b/src/lineage/templates/clean_template.md index 90a23e6..1bb5685 100644 --- a/src/lineage/templates/clean_template.md +++ b/src/lineage/templates/clean_template.md @@ -11,10 +11,8 @@ your project. ## ✅ Pre-approval checklist ## - - - - +- Remove any of the following that do not apply. +- If you're unsure about any of these, don't hesitate to ask. We're here to help! - [ ] Changes are limited to a single goal - *eschew scope creep!* - [ ] *All* future TODOs are captured in issues, which are referenced @@ -29,16 +27,15 @@ your project. ## ✅ Pre-merge checklist ## - - - +- Remove any of the following that do not apply. +- These boxes should remain unchecked until the pull request has been approved. - [ ] Bump version via the `bump_version.sh` script, if this repository is versioned. ## ✅ Post-merge checklist ## - +- Remove any of the following that do not apply. - [ ] Create a release. diff --git a/src/lineage/templates/conflict_template.md b/src/lineage/templates/conflict_template.md index eb56650..b075b6d 100644 --- a/src/lineage/templates/conflict_template.md +++ b/src/lineage/templates/conflict_template.md @@ -60,10 +60,8 @@ that you must resolve before merging this pull request! ## ✅ Pre-approval checklist ## - - - - +- Remove any of the following that do not apply. +- If you're unsure about any of these, don't hesitate to ask. We're here to help! - [ ] ✌️ The conflicts in this pull request have been resolved. - [ ] Changes are limited to a single goal - *eschew scope creep!* @@ -79,16 +77,15 @@ that you must resolve before merging this pull request! ## ✅ Pre-merge checklist ## - - - +- Remove any of the following that do not apply. +- These boxes should remain unchecked until the pull request has been approved. - [ ] Bump version via the `bump_version.sh` script, if this repository is versioned. ## ✅ Post-merge checklist ## - +- Remove any of the following that do not apply. - [ ] Create a release. From 8d6fa98d4e4317a24a8cb4e34cd90149eadec020 Mon Sep 17 00:00:00 2001 From: Shane Frasier Date: Wed, 8 Mar 2023 09:26:37 -0500 Subject: [PATCH 6/7] Remove checklist items that do not apply to automatically generated PRs Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com> --- src/lineage/templates/clean_template.md | 3 --- src/lineage/templates/conflict_template.md | 3 --- 2 files changed, 6 deletions(-) diff --git a/src/lineage/templates/clean_template.md b/src/lineage/templates/clean_template.md index 1bb5685..a2399be 100644 --- a/src/lineage/templates/clean_template.md +++ b/src/lineage/templates/clean_template.md @@ -14,12 +14,9 @@ your project. - Remove any of the following that do not apply. - If you're unsure about any of these, don't hesitate to ask. We're here to help! -- [ ] Changes are limited to a single goal - *eschew scope creep!* - [ ] *All* future TODOs are captured in issues, which are referenced in code comments. - [ ] All relevant type-of-change labels have been added. -- [ ] I have read the [CONTRIBUTING](../blob/develop/CONTRIBUTING.md) document. -- [ ] These code changes follow [cisagov code standards](https://github.com/cisagov/development-guide). - [ ] All relevant repo and/or project documentation has been updated to reflect the changes in this PR. - [ ] Tests have been added and/or modified to cover the changes in this PR. diff --git a/src/lineage/templates/conflict_template.md b/src/lineage/templates/conflict_template.md index b075b6d..81cdb91 100644 --- a/src/lineage/templates/conflict_template.md +++ b/src/lineage/templates/conflict_template.md @@ -64,12 +64,9 @@ that you must resolve before merging this pull request! - If you're unsure about any of these, don't hesitate to ask. We're here to help! - [ ] ✌️ The conflicts in this pull request have been resolved. -- [ ] Changes are limited to a single goal - *eschew scope creep!* - [ ] *All* future TODOs are captured in issues, which are referenced in code comments. - [ ] All relevant type-of-change labels have been added. -- [ ] I have read the [CONTRIBUTING](../blob/develop/CONTRIBUTING.md) document. -- [ ] These code changes follow [cisagov code standards](https://github.com/cisagov/development-guide). - [ ] All relevant repo and/or project documentation has been updated to reflect the changes in this PR. - [ ] Tests have been added and/or modified to cover the changes in this PR. From 3364e18748ffb9269bb5c52c56e2ef90ae6584ec Mon Sep 17 00:00:00 2001 From: Jeremy Frasier Date: Wed, 8 Mar 2023 09:51:08 -0500 Subject: [PATCH 7/7] Clarify that a version bump should only be done when appropriate Changes to internal dependencies that do not change the API (or the build product) do not require and should not receive a version bump. Co-authored-by: Nicholas McDonnell <50747025+mcdonnnj@users.noreply.github.com> --- src/lineage/templates/clean_template.md | 7 +++++-- src/lineage/templates/conflict_template.md | 7 +++++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/src/lineage/templates/clean_template.md b/src/lineage/templates/clean_template.md index a2399be..745e534 100644 --- a/src/lineage/templates/clean_template.md +++ b/src/lineage/templates/clean_template.md @@ -27,8 +27,11 @@ your project. - Remove any of the following that do not apply. - These boxes should remain unchecked until the pull request has been approved. -- [ ] Bump version via the `bump_version.sh` script, if this - repository is versioned. +- [ ] Bump major, minor, patch, or pre-release version [as + appropriate](https://semver.org/#semantic-versioning-specification-semver) + via the `bump_version.sh` script *if* this repository is + versioned *and* the changes in this PR [warrant a version + bump](https://semver.org/#what-should-i-do-if-i-update-my-own-dependencies-without-changing-the-public-api). ## ✅ Post-merge checklist ## diff --git a/src/lineage/templates/conflict_template.md b/src/lineage/templates/conflict_template.md index 81cdb91..905f0d6 100644 --- a/src/lineage/templates/conflict_template.md +++ b/src/lineage/templates/conflict_template.md @@ -77,8 +77,11 @@ that you must resolve before merging this pull request! - Remove any of the following that do not apply. - These boxes should remain unchecked until the pull request has been approved. -- [ ] Bump version via the `bump_version.sh` script, if this - repository is versioned. +- [ ] Bump major, minor, patch, or pre-release version [as + appropriate](https://semver.org/#semantic-versioning-specification-semver) + via the `bump_version.sh` script *if* this repository is + versioned *and* the changes in this PR [warrant a version + bump](https://semver.org/#what-should-i-do-if-i-update-my-own-dependencies-without-changing-the-public-api). ## ✅ Post-merge checklist ##