From 618987a92c2f7311533d44ce914dbbe806efb362 Mon Sep 17 00:00:00 2001 From: Kyle McCormick Date: Thu, 12 Jun 2025 12:03:28 -0400 Subject: [PATCH 1/6] feat: Introduce Fast-Track DEPR Template --- .../ISSUE_TEMPLATE/depr-ticket-fast-track.yml | 40 +++++++++++++++++++ .github/ISSUE_TEMPLATE/depr-ticket.yml | 2 +- 2 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml diff --git a/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml b/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml new file mode 100644 index 0000000..e2e8f73 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml @@ -0,0 +1,40 @@ +name: 🚅 Fast-Track Deprecation/Removal (DEPR) +description: Per OEP-21, use this template when you are making a pre-approved breaking change. These include: Pre-planned upgrade tasks, removal of unreachable code, and subtasks of other approved DEPR tickets. Consult the DEPR Working Group if unsure. +title: "[DEPR]: " +labels: ["DEPR"] +body: + - type: markdown + attributes: + value: | + Refer to [OEP-21](https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0021-proc-deprecation.html) for more detail on the deprecation and removal process. This ticket should only be used for proposing the removal of an Open edX technology. + Please leave [DEPR] in the title of your ticket! + - type: input + id: breaking-change-unblocked-date + attributes: + label: Earliest Breaking Changes Unblocked Date + description: When is the earliest date you may make breaking changes? A good default is 2 weeks from today, giving operators time to transition. + placeholder: "2025-01-01" + validations: + required: true + - type: textarea + id: rationale + attributes: + label: Rationale + description: Explain, briefly, why this breaking change needs to happen. Because you are fast-tracking this, please link to supporting information, such as an upgrade plan. + validations: + required: true + - type: textarea + id: removal + attributes: + label: Description + description: What functionality is being removed? What functionality, if any, replaces it? How can operators transition? + validations: + required: true + - type: textarea + id: removal-tasks + attributes: + label: Task List + description: (Optional) A list of tasks or PRs to complete this + placeholder: "- [ ] Task 1" + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/depr-ticket.yml b/.github/ISSUE_TEMPLATE/depr-ticket.yml index 7412d8e..e1156ac 100644 --- a/.github/ISSUE_TEMPLATE/depr-ticket.yml +++ b/.github/ISSUE_TEMPLATE/depr-ticket.yml @@ -1,4 +1,4 @@ -name: 🌘 Deprecation and Removal (DEPR) Ticket +name: 🌘 Standard Deprecation/Removal (DEPR) description: Per OEP-21, use this template to begin the technology deprecation process. title: "[DEPR]: " labels: ["DEPR"] From 126df468a0d9c9c5a62ba18b8ba83c5c9e064c2b Mon Sep 17 00:00:00 2001 From: Kyle McCormick Date: Thu, 12 Jun 2025 14:00:06 -0400 Subject: [PATCH 2/6] docs: fix description Co-authored-by: Taylor Payne --- .github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml b/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml index e2e8f73..11f39d0 100644 --- a/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml +++ b/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml @@ -1,5 +1,5 @@ name: 🚅 Fast-Track Deprecation/Removal (DEPR) -description: Per OEP-21, use this template when you are making a pre-approved breaking change. These include: Pre-planned upgrade tasks, removal of unreachable code, and subtasks of other approved DEPR tickets. Consult the DEPR Working Group if unsure. +description: Per OEP-21, use this template when you are making a pre-approved breaking change. These include pre-planned upgrade tasks, removal of unreachable code, and subtasks of other approved DEPR tickets. Consult the DEPR Working Group if unsure. title: "[DEPR]: " labels: ["DEPR"] body: From a1b5143cb8fd5d50437d978f4f259ffea418d56c Mon Sep 17 00:00:00 2001 From: Kyle McCormick Date: Thu, 12 Jun 2025 14:08:54 -0400 Subject: [PATCH 3/6] docs: code review Co-authored-by: Robert Raposa --- .github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml b/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml index 11f39d0..133290a 100644 --- a/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml +++ b/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml @@ -13,7 +13,7 @@ body: attributes: label: Earliest Breaking Changes Unblocked Date description: When is the earliest date you may make breaking changes? A good default is 2 weeks from today, giving operators time to transition. - placeholder: "2025-01-01" + placeholder: "2025-01-14" validations: required: true - type: textarea From 20027b4a6c08048e55eff0e38f71a3dc2d749469 Mon Sep 17 00:00:00 2001 From: Kyle McCormick Date: Thu, 12 Jun 2025 14:11:54 -0400 Subject: [PATCH 4/6] docs: shorten description --- .github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml b/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml index 133290a..dde4c7b 100644 --- a/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml +++ b/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml @@ -1,5 +1,5 @@ name: 🚅 Fast-Track Deprecation/Removal (DEPR) -description: Per OEP-21, use this template when you are making a pre-approved breaking change. These include pre-planned upgrade tasks, removal of unreachable code, and subtasks of other approved DEPR tickets. Consult the DEPR Working Group if unsure. +description: Announce a pre-approved breaking change. These include planned upgrade tasks, removal of unreachable code, and subtasks of other approved DEPR tickets. Consult the DEPR Working Group if unsure. title: "[DEPR]: " labels: ["DEPR"] body: From 2c1311b1a689e6e41955108ac4ad956a574f7515 Mon Sep 17 00:00:00 2001 From: Kyle McCormick Date: Thu, 12 Jun 2025 14:23:03 -0400 Subject: [PATCH 5/6] docs: link to issue --- .github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml b/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml index dde4c7b..27a46cd 100644 --- a/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml +++ b/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml @@ -6,7 +6,7 @@ body: - type: markdown attributes: value: | - Refer to [OEP-21](https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0021-proc-deprecation.html) for more detail on the deprecation and removal process. This ticket should only be used for proposing the removal of an Open edX technology. + The standard DEPR process is described in [OEP-21](https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0021-proc-deprecation.html). This issue will follow a [simpler, expedited version of that process](https://github.com/openedx/.github/issues/175). Slack message `#wg-depr-slash-and-burn` if you are confused. Please leave [DEPR] in the title of your ticket! - type: input id: breaking-change-unblocked-date From 84f1857914b56abd746f8e8366c233244f3bb8df Mon Sep 17 00:00:00 2001 From: Kyle McCormick Date: Thu, 12 Jun 2025 14:30:17 -0400 Subject: [PATCH 6/6] docs: better template helptext --- .github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml b/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml index 27a46cd..bc01fba 100644 --- a/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml +++ b/.github/ISSUE_TEMPLATE/depr-ticket-fast-track.yml @@ -6,7 +6,10 @@ body: - type: markdown attributes: value: | - The standard DEPR process is described in [OEP-21](https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0021-proc-deprecation.html). This issue will follow a [simpler, expedited version of that process](https://github.com/openedx/.github/issues/175). Slack message `#wg-depr-slash-and-burn` if you are confused. + This announces a pre-approved breaking change. These include planned upgrade tasks, removal of unreachable code, and subtasks of other approved DEPR tickets. Consult the DEPR Working Group if unsure. + + The standard DEPR process is described in [OEP-21](https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0021-proc-deprecation.html). This ticket is using the new ["Fast Track" Process]((https://github.com/openedx/.github/issues/175)), which means it will skip the Request-For-Comments (RFC) stages and move right to "Transition Unblocked." + Please leave [DEPR] in the title of your ticket! - type: input id: breaking-change-unblocked-date