From 80d6f7244fe227b5437fd900ed1b9a0ef0145627 Mon Sep 17 00:00:00 2001 From: Kelly Song Date: Thu, 24 Oct 2024 15:30:17 -0700 Subject: [PATCH 01/10] add breaking change template --- .github/ISSUE_TEMPLATE/breaking_change.yml | 70 ++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/breaking_change.yml diff --git a/.github/ISSUE_TEMPLATE/breaking_change.yml b/.github/ISSUE_TEMPLATE/breaking_change.yml new file mode 100644 index 0000000000..5fd04fdf32 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/breaking_change.yml @@ -0,0 +1,70 @@ +# This issue template is for use in opening issues that document breaking changes. This template should be used to create an issue by Microsoft product team members who are documenting a breaking change. +# +# Bracketed text is a placeholder; replace the text with the requested information and remove the brackets before submitting the issue. Also, remove this comment before submitting the issue. + +name: "Identity Model breaking change" +description: Report a change in Identity Model that breaks something that worked in a previous version. This form is intended to be used by the product team. +title: "[Breaking change]: " +labels: "Breaking change" +body: + - type: textarea + id: description + attributes: + label: Description + description: Brief description of the breaking change. + validations: + required: true + - type: input + id: version + attributes: + label: Version + description: What version of Identity Model introduced the breaking change? + validations: + required: true + - type: textarea + id: old-behavior + attributes: + label: Previous behavior + description: Describe the previous behavior. Include code snippets if applicable. + validations: + required: true + - type: textarea + id: new-behavior + attributes: + label: New behavior + description: Describe the new behavior. Include code snippets if applicable. + validations: + required: true + - type: checkboxes + id: change-type + attributes: + label: Type of breaking change + description: This information will be used to label the issue appropriately. [(How do I decide?)](https://learn.microsoft.com/dotnet/core/compatibility/categories) + options: + - label: "**Binary incompatible**: Existing binaries may encounter a breaking change in behavior, such as failure to load or execute, and if so, require recompilation." + - label: "**Source incompatible**: When recompiled using the new SDK or component or to target the new runtime, existing source code may require source changes to compile successfully." + - label: "**Behavioral change**: Existing binaries may behave differently at run time." + validations: + required: true + - type: textarea + id: reason + attributes: + label: Reason for change + description: Describe why the breaking change was introduced. + validations: + required: true + - type: textarea + id: recommended-action + attributes: + label: Recommended action + description: Describe the recommended action an affected user should take, such as workarounds or examples of code changes. + validations: + required: true + - type: textarea + id: affected-apis + attributes: + label: Affected APIs + description: List all the APIs affected by this change. For methods, clarify if it's all overloads or specific overloads. + placeholder: None. + validations: + required: true \ No newline at end of file From b8791a7bf51c9721e99fda09d38dbfc68c7893c2 Mon Sep 17 00:00:00 2001 From: Kelly Song Date: Thu, 31 Oct 2024 15:58:01 -0700 Subject: [PATCH 02/10] rename template and rework to suit the late rel exemption purpose --- .github/ISSUE_TEMPLATE/breaking_change.yml | 70 ------------------- .../ISSUE_TEMPLATE/late_release_exception.yml | 50 +++++++++++++ 2 files changed, 50 insertions(+), 70 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/breaking_change.yml create mode 100644 .github/ISSUE_TEMPLATE/late_release_exception.yml diff --git a/.github/ISSUE_TEMPLATE/breaking_change.yml b/.github/ISSUE_TEMPLATE/breaking_change.yml deleted file mode 100644 index 5fd04fdf32..0000000000 --- a/.github/ISSUE_TEMPLATE/breaking_change.yml +++ /dev/null @@ -1,70 +0,0 @@ -# This issue template is for use in opening issues that document breaking changes. This template should be used to create an issue by Microsoft product team members who are documenting a breaking change. -# -# Bracketed text is a placeholder; replace the text with the requested information and remove the brackets before submitting the issue. Also, remove this comment before submitting the issue. - -name: "Identity Model breaking change" -description: Report a change in Identity Model that breaks something that worked in a previous version. This form is intended to be used by the product team. -title: "[Breaking change]: " -labels: "Breaking change" -body: - - type: textarea - id: description - attributes: - label: Description - description: Brief description of the breaking change. - validations: - required: true - - type: input - id: version - attributes: - label: Version - description: What version of Identity Model introduced the breaking change? - validations: - required: true - - type: textarea - id: old-behavior - attributes: - label: Previous behavior - description: Describe the previous behavior. Include code snippets if applicable. - validations: - required: true - - type: textarea - id: new-behavior - attributes: - label: New behavior - description: Describe the new behavior. Include code snippets if applicable. - validations: - required: true - - type: checkboxes - id: change-type - attributes: - label: Type of breaking change - description: This information will be used to label the issue appropriately. [(How do I decide?)](https://learn.microsoft.com/dotnet/core/compatibility/categories) - options: - - label: "**Binary incompatible**: Existing binaries may encounter a breaking change in behavior, such as failure to load or execute, and if so, require recompilation." - - label: "**Source incompatible**: When recompiled using the new SDK or component or to target the new runtime, existing source code may require source changes to compile successfully." - - label: "**Behavioral change**: Existing binaries may behave differently at run time." - validations: - required: true - - type: textarea - id: reason - attributes: - label: Reason for change - description: Describe why the breaking change was introduced. - validations: - required: true - - type: textarea - id: recommended-action - attributes: - label: Recommended action - description: Describe the recommended action an affected user should take, such as workarounds or examples of code changes. - validations: - required: true - - type: textarea - id: affected-apis - attributes: - label: Affected APIs - description: List all the APIs affected by this change. For methods, clarify if it's all overloads or specific overloads. - placeholder: None. - validations: - required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/late_release_exception.yml b/.github/ISSUE_TEMPLATE/late_release_exception.yml new file mode 100644 index 0000000000..7d097894fd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/late_release_exception.yml @@ -0,0 +1,50 @@ +# This issue template is for use in opening issues that document late release exception requests. +# +# Bracketed text is a placeholder; replace the text with the requested information and remove the brackets before submitting the issue. Also, remove this comment before submitting the issue. + +name: "Identity Model Late Release Exception Request" +description: Request an exception to release a feature after the release candidate deadline. +title: "[Late Release Exception]: " +labels: "Late Release Exception" +body: + - type: textarea + id: description + attributes: + label: Description + description: Brief description of the feature. + validations: + required: true + - type: input + id: release-date + attributes: + label: Date + description: Which release date are you targeting? + validations: + required: true + - type: dropdown + id: version-bump + attributes: + label: Type of version bump + description: Indicate if this feature would incur a major, minor, or patch version bump. + options: + - label: "Major" + - label: "Minor" + - label: "Patch" + - label: "I don't know." + validations: + required: true + - type: textarea + id: reason + attributes: + label: Reason for exception + description: Please explain why the feature release can't wait until the next month. + validations: + required: true + - type: textarea + id: test-attestation + attributes: + label: test attestation + description: Describe the testing and validation that was conducted for this feature. Include links to test coverage, proof of partner validation, etc. + validations: + required: true + \ No newline at end of file From 4566e87b95ce6011ee7d7a8ce93603c60ea2b87f Mon Sep 17 00:00:00 2001 From: Kelly Song Date: Thu, 31 Oct 2024 16:01:30 -0700 Subject: [PATCH 03/10] update testing-attestation name --- .github/ISSUE_TEMPLATE/late_release_exception.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/late_release_exception.yml b/.github/ISSUE_TEMPLATE/late_release_exception.yml index 7d097894fd..cdafd39093 100644 --- a/.github/ISSUE_TEMPLATE/late_release_exception.yml +++ b/.github/ISSUE_TEMPLATE/late_release_exception.yml @@ -41,9 +41,9 @@ body: validations: required: true - type: textarea - id: test-attestation + id: testing-attestation attributes: - label: test attestation + label: Testing attestation description: Describe the testing and validation that was conducted for this feature. Include links to test coverage, proof of partner validation, etc. validations: required: true From a446fdbcc3d6c1bc1b37172bbfff2b880a8664f3 Mon Sep 17 00:00:00 2001 From: Kelly Song Date: Thu, 31 Oct 2024 16:26:05 -0700 Subject: [PATCH 04/10] add oter libraries sections and notify rel v-team sections --- .../ISSUE_TEMPLATE/late_release_exception.yml | 27 ++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/late_release_exception.yml b/.github/ISSUE_TEMPLATE/late_release_exception.yml index cdafd39093..f4888b69f6 100644 --- a/.github/ISSUE_TEMPLATE/late_release_exception.yml +++ b/.github/ISSUE_TEMPLATE/late_release_exception.yml @@ -30,9 +30,26 @@ body: - label: "Major" - label: "Minor" - label: "Patch" - - label: "I don't know." + - label: "Not sure" validations: required: true + - type: checkboxes + id: other-libraries + attributes: + label: Other libraries + description: Does this feature release rely on the release of any other libraries? + options: + - label: "Yes" + - label: "No" + validations: + required: true + - type: checkboxes + id: if-relies-on-other-libraries + attributes: + label: If you answered "yes" to the previous question, please indicate which libraries also need to be released. + description: Check the boxes of the other libraries that also be released. + options: + - label: Microsoft.Identity.Abstractions - type: textarea id: reason attributes: @@ -47,4 +64,12 @@ body: description: Describe the testing and validation that was conducted for this feature. Include links to test coverage, proof of partner validation, etc. validations: required: true + - type: checkboxes + id: terms + attributes: + label: Notify the Release V-Team + description: After submitting this issue, you agree to notify the release v-team. + options: + - label: I agree to email the issue link to the release v-team. + required: true \ No newline at end of file From c15c8a5328a8831639050a5c581537fc81006fbd Mon Sep 17 00:00:00 2001 From: Kelly Song Date: Thu, 31 Oct 2024 16:27:05 -0700 Subject: [PATCH 05/10] reduce verbiage --- .github/ISSUE_TEMPLATE/late_release_exception.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/late_release_exception.yml b/.github/ISSUE_TEMPLATE/late_release_exception.yml index f4888b69f6..8308539a5c 100644 --- a/.github/ISSUE_TEMPLATE/late_release_exception.yml +++ b/.github/ISSUE_TEMPLATE/late_release_exception.yml @@ -46,7 +46,7 @@ body: - type: checkboxes id: if-relies-on-other-libraries attributes: - label: If you answered "yes" to the previous question, please indicate which libraries also need to be released. + label: If you answered "yes" to the previous question, please indicate which libraries. description: Check the boxes of the other libraries that also be released. options: - label: Microsoft.Identity.Abstractions From 3c1aab9eb4ac67856de7d146ffb86c95e67ea7d5 Mon Sep 17 00:00:00 2001 From: Kelly Song Date: Thu, 31 Oct 2024 16:27:57 -0700 Subject: [PATCH 06/10] reduce verbiage pt 2 --- .github/ISSUE_TEMPLATE/late_release_exception.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/late_release_exception.yml b/.github/ISSUE_TEMPLATE/late_release_exception.yml index 8308539a5c..cfffc1940b 100644 --- a/.github/ISSUE_TEMPLATE/late_release_exception.yml +++ b/.github/ISSUE_TEMPLATE/late_release_exception.yml @@ -70,6 +70,6 @@ body: label: Notify the Release V-Team description: After submitting this issue, you agree to notify the release v-team. options: - - label: I agree to email the issue link to the release v-team. + - label: I agree. required: true \ No newline at end of file From c6aa1645b147b150fa4bbddf832686d1cca7e50e Mon Sep 17 00:00:00 2001 From: Kelly Song Date: Fri, 1 Nov 2024 11:45:32 -0700 Subject: [PATCH 07/10] accept all suggestions --- .github/ISSUE_TEMPLATE/late_release_exception.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/late_release_exception.yml b/.github/ISSUE_TEMPLATE/late_release_exception.yml index cfffc1940b..153f845aa9 100644 --- a/.github/ISSUE_TEMPLATE/late_release_exception.yml +++ b/.github/ISSUE_TEMPLATE/late_release_exception.yml @@ -2,8 +2,8 @@ # # Bracketed text is a placeholder; replace the text with the requested information and remove the brackets before submitting the issue. Also, remove this comment before submitting the issue. -name: "Identity Model Late Release Exception Request" -description: Request an exception to release a feature after the release candidate deadline. +name: "IdentityModel Release Exception Request" +description: Request an exception to release a feature or add any changes after the release candidate deadline, excludes fixes for preview regressions. title: "[Late Release Exception]: " labels: "Late Release Exception" body: @@ -37,7 +37,7 @@ body: id: other-libraries attributes: label: Other libraries - description: Does this feature release rely on the release of any other libraries? + description: Does this feature release rely on the release of any other ID4S libraries? options: - label: "Yes" - label: "No" @@ -47,7 +47,7 @@ body: id: if-relies-on-other-libraries attributes: label: If you answered "yes" to the previous question, please indicate which libraries. - description: Check the boxes of the other libraries that also be released. + description: Check the boxes of the other ID4S libraries to be released. options: - label: Microsoft.Identity.Abstractions - type: textarea From 8dbb1fe06d4bdd0dc54329fb03f76f7e28a31b15 Mon Sep 17 00:00:00 2001 From: Kelly Song Date: Fri, 1 Nov 2024 15:24:35 -0700 Subject: [PATCH 08/10] change requests --- .github/ISSUE_TEMPLATE/late_release_exception.yml | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/late_release_exception.yml b/.github/ISSUE_TEMPLATE/late_release_exception.yml index 153f845aa9..213067886b 100644 --- a/.github/ISSUE_TEMPLATE/late_release_exception.yml +++ b/.github/ISSUE_TEMPLATE/late_release_exception.yml @@ -1,11 +1,9 @@ -# This issue template is for use in opening issues that document late release exception requests. -# -# Bracketed text is a placeholder; replace the text with the requested information and remove the brackets before submitting the issue. Also, remove this comment before submitting the issue. +# This issue template is for use in opening issues that document Ask Mode Changes, for features or changes that come after the release candidate deadline. -name: "IdentityModel Release Exception Request" +name: "IdentityModel Ask Mode Change" description: Request an exception to release a feature or add any changes after the release candidate deadline, excludes fixes for preview regressions. -title: "[Late Release Exception]: " -labels: "Late Release Exception" +title: "[Ask Mode Change]: " +labels: "Ask Mode Change" body: - type: textarea id: description @@ -41,6 +39,7 @@ body: options: - label: "Yes" - label: "No" + required: true validations: required: true - type: checkboxes From 9cafab256a6c382220976f55dedc971b3c7670e1 Mon Sep 17 00:00:00 2001 From: Kelly Song Date: Fri, 1 Nov 2024 15:25:41 -0700 Subject: [PATCH 09/10] rm required from 'no' option in other libraries section --- .github/ISSUE_TEMPLATE/late_release_exception.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/late_release_exception.yml b/.github/ISSUE_TEMPLATE/late_release_exception.yml index 213067886b..7c6880aab1 100644 --- a/.github/ISSUE_TEMPLATE/late_release_exception.yml +++ b/.github/ISSUE_TEMPLATE/late_release_exception.yml @@ -39,7 +39,6 @@ body: options: - label: "Yes" - label: "No" - required: true validations: required: true - type: checkboxes From 0a4c07234f369bf3bdb20c6fac97eba372f221ea Mon Sep 17 00:00:00 2001 From: Kelly Song Date: Fri, 1 Nov 2024 15:28:51 -0700 Subject: [PATCH 10/10] rename tempalte to ask mode change --- .../{late_release_exception.yml => ask_mode_change.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/ISSUE_TEMPLATE/{late_release_exception.yml => ask_mode_change.yml} (100%) diff --git a/.github/ISSUE_TEMPLATE/late_release_exception.yml b/.github/ISSUE_TEMPLATE/ask_mode_change.yml similarity index 100% rename from .github/ISSUE_TEMPLATE/late_release_exception.yml rename to .github/ISSUE_TEMPLATE/ask_mode_change.yml