Skip to content

Commit

Permalink
fix(action): ensure retrocompatibility of issue template check (#21478)
Browse files Browse the repository at this point in the history
## **Description**
The issue template used to have a section called '### Screenshots' which
got replaced by '### Screenshots/Recordings'.
Since many issues were created before this check, we want to keep
accepting both formats.
In January 2024, we can assume most issues will have adopted '###
Screenshots/Recordings' and we'll be able to remove that
retro-compatibility condition.

## **Manual testing steps**

- Create a new issue
- Replace section title '### Screenshots/Recordings' by '###
Screenshots'
- Wait for 30s until the Github action has run
- No INVALID_ISSUE_TEMPLATE label shall appear on the issue.

## **Screenshots/Recordings**

NA

### **Before**

NA

### **After**

NA

## **Related issues**

NA

## **Pre-merge author checklist**

- [x] I’ve followed [MetaMask Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've clearly explained:
  - [x] What problem this PR is solving.
  - [x] How this problem was solved.
  - [x] How reviewers can test my changes.
- [ ] I’ve indicated what issue this PR is linked to: Fixes #???
- [ ] I’ve included tests if applicable.
- [x] I’ve documented any added code.
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
- [x] I’ve properly set the pull request status:
  - [ ] In case it's not yet "ready for review", I've set it to "draft".
- [x] In case it's "ready for review", I've changed it from "draft" to
"non-draft".

## **Pre-merge reviewer checklist**

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.
  • Loading branch information
gauthierpetetin authored Oct 23, 2023
1 parent 3143e8a commit 416c8ff
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion .github/scripts/check-issue-template-and-add-labels.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ const generalIssueTemplateTitles = [
const bugReportTemplateTitles = [
'### Describe the bug',
'### Expected behavior',
'### Screenshots/Recordings',
'### Screenshots', // TODO: replace '### Screenshots' by '### Screenshots/Recordings' in January 2024 (as most issues will meet this criteria by then)
'### Steps to reproduce',
'### Error messages or log output',
'### Version',
Expand Down

0 comments on commit 416c8ff

Please sign in to comment.