-
Notifications
You must be signed in to change notification settings - Fork 31
feat: Introduce Fast-Track DEPR Template #174
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
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
618987a
feat: Introduce Fast-Track DEPR Template
kdmccormick 126df46
docs: fix description
kdmccormick a1b5143
docs: code review
kdmccormick 20027b4
docs: shorten description
kdmccormick 2c1311b
docs: link to issue
kdmccormick 84f1857
docs: better template helptext
kdmccormick File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| name: 🚅 Fast-Track Deprecation/Removal (DEPR) | ||
| 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]: <Technology Name>" | ||
| labels: ["DEPR"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| 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 | ||
| 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-14" | ||
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| name: 🌘 Deprecation and Removal (DEPR) Ticket | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Note: The term "ticket" is used in the OEP. Is there an expected follow-up to change that?
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can do |
||
| name: 🌘 Standard Deprecation/Removal (DEPR) | ||
| description: Per OEP-21, use this template to begin the technology deprecation process. | ||
| title: "[DEPR]: <Technology Name>" | ||
| labels: ["DEPR"] | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.