Skip to content

Commit

Permalink
Merge DEPR automation workflow
Browse files Browse the repository at this point in the history
Add DEPR workflow automation & default issue overrides
  • Loading branch information
sarina authored Feb 24, 2022
2 parents 8d97aa4 + e2c9228 commit d2ced47
Show file tree
Hide file tree
Showing 3 changed files with 108 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Open edX Community Support
url: https://discuss.openedx.org/
about: Please ask all questions, suggest all enhancements, and report all bugs here.
84 changes: 84 additions & 0 deletions .github/ISSUE_TEMPLATE/depr-ticket.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
name: Deprecation (DEPR) Ticket
description: Per OEP-21, use this template to begin the technology deprecation process.
title: "[DEPR]: <Technology Name>"
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: todays-date
attributes:
label: Proposal Date
description: The start date of this proposal (likely today)
placeholder: 29 February 2020
validations:
required: true
- type: input
id: accept-date
attributes:
label: Ticket Acceptance Date
description: When is the target date for getting this proposal accepted?
placeholder: 29 February 2020
validations:
required: true
- type: input
id: remove-date
attributes:
label: Technology Removal Date
description: When is the target date for getting this technology removed?
placeholder: 29 February 2020
validations:
required: true
- type: input
id: named-release-without
attributes:
label: First Open edX Named Release Without This Functionality
description: Named releases are generally CUT in early April and early October. Based on the above removal date, what named release would be the first without this code? Please reach out to the Build Test Release working group (#wg-build-test-release in Slack) if you're not sure.
placeholder: Dogwood
validations:
required: true
- type: textarea
id: rationale
attributes:
label: Rationale
description: Explain, in a few sentences, why this technology should be removed - what's the usage pattern? What's wrong with keeping it around?
validations:
required: true
- type: textarea
id: removal
attributes:
label: Removal
description: Include a description with links to what exactly is being removed.
validations:
required: true
- type: textarea
id: replacement
attributes:
label: Replacement
description: Include a description with links to what this is being replaced by.
validations:
required: true
- type: textarea
id: deprecation
attributes:
label: Deprecation
description: If you plan to mark the code for deprecation, explain how.
validations:
required: false
- type: textarea
id: migration
attributes:
label: Migration
description: If automated migration will be needed, explain your migration plan.
validations:
required: false
- type: textarea
id: addl-info
attributes:
label: Additional Info
description: If there is any additional publicly sharable information or data from your earlier analysis, include that.
validations:
required: false
19 changes: 19 additions & 0 deletions .github/workflows/add-depr-ticket-to-depr-board.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Run the workflow that adds new tickets that are either:
# - labelled "DEPR"
# - title starts with "[DEPR]"
# - body starts with "Proposal Date" (this is the first template field)
# to the org-wide DEPR project board

name: Add newly created DEPR issues to the DEPR project board

on:
issues:
types: [opened]

jobs:
routeissue:
uses: openedx/.github/.github/workflows/add-depr-ticket-to-depr-board.yml@master
secrets:
GITHUB_APP_ID: ${{ secrets.GRAPHQL_AUTH_APP_ID }}
GITHUB_APP_PRIVATE_KEY: ${{ secrets.GRAPHQL_AUTH_APP_PEM }}
SLACK_BOT_TOKEN: ${{ secrets.SLACK_ISSUE_BOT_TOKEN }}

0 comments on commit d2ced47

Please sign in to comment.