Migrate issue templates to .yml (#3659)
* Added issue yml templates * Fixed yml syntax * Removed md templates * updated tool request template * fixed windows 2016 naming and bug report dropdown * Styling and wording fixes * Added validation requirements * removed empty issue check * Removed issue triager
This commit is contained in:
Alena Sviridenko
@@ -1,34 +0,0 @@
|
|||||||
---
|
|
||||||
name: Announcement
|
|
||||||
about: Submit an announcement
|
|
||||||
title: ''
|
|
||||||
labels: Announcement
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Breaking changes**
|
|
||||||
<!-- Short description of the upcoming change -->
|
|
||||||
|
|
||||||
**Target date**
|
|
||||||
<!-- Date of changes propagation start -->
|
|
||||||
|
|
||||||
**The motivation for the changes**
|
|
||||||
<!-- Description of main reasons for this change -->
|
|
||||||
|
|
||||||
**Possible impact**
|
|
||||||
<!-- Description of who might be impacted by this change -->
|
|
||||||
|
|
||||||
**Virtual environments affected**
|
|
||||||
- [ ] Ubuntu 16.04
|
|
||||||
- [ ] Ubuntu 18.04
|
|
||||||
- [ ] Ubuntu 20.04
|
|
||||||
- [ ] macOS 10.13
|
|
||||||
- [ ] macOS 10.14
|
|
||||||
- [ ] macOS 10.15
|
|
||||||
- [ ] macOS 11
|
|
||||||
- [ ] Windows Server 2016 R2
|
|
||||||
- [ ] Windows Server 2019
|
|
||||||
|
|
||||||
**Mitigation ways**
|
|
||||||
<!-- Steps or options for impact mitigation -->
|
|
||||||
@@ -0,0 +1,48 @@
|
|||||||
|
name: Announcement
|
||||||
|
description: Submit an announcement
|
||||||
|
labels: [Announcement]
|
||||||
|
body:
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Breaking changes
|
||||||
|
placeholder: Short description of the upcoming change
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Target date
|
||||||
|
placeholder: Date of changes propagation start
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: The motivation for the changes
|
||||||
|
placeholder: Description of main reasons for this change
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Possible impact
|
||||||
|
placeholder: Description of who might be impacted by this change
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Virtual environments affected
|
||||||
|
options:
|
||||||
|
- label: Ubuntu 16.04
|
||||||
|
- label: Ubuntu 18.04
|
||||||
|
- label: Ubuntu 20.04
|
||||||
|
- label: macOS 10.15
|
||||||
|
- label: macOS 11
|
||||||
|
- label: Windows Server 2016
|
||||||
|
- label: Windows Server 2019
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Mitigation ways
|
||||||
|
description: Steps or options for impact mitigation
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
---
|
|
||||||
name: Bug report
|
|
||||||
about: Submit a bug report
|
|
||||||
title: ''
|
|
||||||
labels: needs triage
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Description**
|
|
||||||
A clear and concise description of what the bug is, and why you consider it to be a bug.
|
|
||||||
|
|
||||||
**Area for Triage**:
|
|
||||||
<!-- See https://github.com/actions/virtual-environments/tree/main/triage-rules.yml for areas -->
|
|
||||||
|
|
||||||
**Question, Bug, or Feature?**:
|
|
||||||
<!-- Choose "Question", "Bug", or "Feature" -->
|
|
||||||
|
|
||||||
**Virtual environments affected**
|
|
||||||
- [ ] Ubuntu 16.04
|
|
||||||
- [ ] Ubuntu 18.04
|
|
||||||
- [ ] Ubuntu 20.04
|
|
||||||
- [ ] macOS 10.15
|
|
||||||
- [ ] macOS 11
|
|
||||||
- [ ] Windows Server 2016 R2
|
|
||||||
- [ ] Windows Server 2019
|
|
||||||
|
|
||||||
**Image version**
|
|
||||||
<!-- Image version can be found in build logs under "Set up job" -> "Virtual Environment" -> "Version" -->
|
|
||||||
Image version where you are experiencing the issue.
|
|
||||||
|
|
||||||
**Expected behavior**
|
|
||||||
A description of what you expected to happen.
|
|
||||||
|
|
||||||
**Actual behavior**
|
|
||||||
A description of what is actually happening.
|
|
||||||
|
|
||||||
**Repro steps**
|
|
||||||
A description with steps to reproduce the issue. If your have a public example or repo to share,
|
|
||||||
please provide the link.
|
|
||||||
|
|
||||||
1. Step 1
|
|
||||||
2. Step 2
|
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
name: Bug Report
|
||||||
|
description: Submit a bug report
|
||||||
|
labels: [needs triage]
|
||||||
|
body:
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Description
|
||||||
|
description: A clear and concise description of what the bug is, and why you consider it to be a bug.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Virtual environments affected
|
||||||
|
options:
|
||||||
|
- label: Ubuntu 16.04
|
||||||
|
- label: Ubuntu 18.04
|
||||||
|
- label: Ubuntu 20.04
|
||||||
|
- label: macOS 10.15
|
||||||
|
- label: macOS 11
|
||||||
|
- label: Windows Server 2016
|
||||||
|
- label: Windows Server 2019
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Image version and build link
|
||||||
|
description: |
|
||||||
|
Image version where you are experiencing the issue. Where to find image version in build logs:
|
||||||
|
1. For GitHub Actions, under "Set up job" -> "Virtual Environment" -> "Version".
|
||||||
|
2. For Azure DevOps, under "Initialize job" -> "Virtual Environment" -> "Version".
|
||||||
|
|
||||||
|
If you have a public example, please, provide a link to the failed build.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Is it regression?
|
||||||
|
description: If yes, please, provide the latest image version where the issue didn't persist, and a link to the latest successful build.
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Expected behavior
|
||||||
|
description: A description of what you expected to happen.
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Actual behavior
|
||||||
|
description: A description of what is actually happening.
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Repro steps
|
||||||
|
placeholder: |
|
||||||
|
A description with steps to reproduce the issue.
|
||||||
|
1. Step 1
|
||||||
|
2. Step 2
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
---
|
|
||||||
name: Tool request
|
|
||||||
about: Request a new tool or update to a tool
|
|
||||||
title: Update/Add [tool name]
|
|
||||||
labels: feature request, needs triage
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Tool information**
|
|
||||||
- Tool name: <!--- Name -->
|
|
||||||
- Tool license: <!--- Type of licensing for desired tool -->
|
|
||||||
- Add or update? <!--- Add or update? -->
|
|
||||||
- Desired version: <!--- Let us know if you're requesting a specific version, dev/RC, whatever is latest, etc. -->
|
|
||||||
- Approximate size: <!--- Leave blank if not known -->
|
|
||||||
- If this is an add request:
|
|
||||||
- Brief description of tool: <!--- Description -->
|
|
||||||
- URL for tool's homepage: <!--- URL -->
|
|
||||||
- Provide a basic test case to validate the tool's functionality: <!-- Code sample -->
|
|
||||||
|
|
||||||
**Area for Triage**:
|
|
||||||
<!-- See https://github.com/actions/virtual-environments/tree/main/triage-rules.yml for areas -->
|
|
||||||
|
|
||||||
**Question, Bug, or Feature?**:
|
|
||||||
<!-- Choose "Question", "Bug", or "Feature" -->
|
|
||||||
|
|
||||||
**Virtual environments affected**
|
|
||||||
- [ ] Ubuntu 16.04
|
|
||||||
- [ ] Ubuntu 18.04
|
|
||||||
- [ ] Ubuntu 20.04
|
|
||||||
- [ ] macOS 10.15
|
|
||||||
- [ ] macOS 11
|
|
||||||
- [ ] Windows Server 2016 R2
|
|
||||||
- [ ] Windows Server 2019
|
|
||||||
|
|
||||||
**Can this tool be installed during the build?**
|
|
||||||
<!--- If so, please provide a description with required steps. -->
|
|
||||||
|
|
||||||
**Tool installation time in runtime**
|
|
||||||
<!--- How long does it take to install the tool? -->
|
|
||||||
|
|
||||||
**Are you willing to submit a PR?**
|
|
||||||
<!--- We accept contributions! -->
|
|
||||||
@@ -0,0 +1,75 @@
|
|||||||
|
name: Tool request
|
||||||
|
description: Request a new tool or update to a tool
|
||||||
|
title: Update/Add [tool name]
|
||||||
|
labels: [feature request, needs triage]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: "## Tool information"
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Tool name
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Tool license
|
||||||
|
description: Type of licensing for desired tool.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Add or update?
|
||||||
|
options:
|
||||||
|
- label: Add
|
||||||
|
- label: Update
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Desired version
|
||||||
|
description: Let us know if you're requesting a specific version, dev/RC, whatever is latest, etc.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Approximate size
|
||||||
|
description: Leave blank if unknown.
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: "## If this is an add request"
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Brief description of tool
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: URL for tool's homepage
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Provide a basic test case to validate the tool's functionality.
|
||||||
|
description: This will be automatically formatted into code.
|
||||||
|
render: bash
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Virtual environments affected
|
||||||
|
options:
|
||||||
|
- label: Ubuntu 16.04
|
||||||
|
- label: Ubuntu 18.04
|
||||||
|
- label: Ubuntu 20.04
|
||||||
|
- label: macOS 10.15
|
||||||
|
- label: macOS 11
|
||||||
|
- label: Windows Server 2016
|
||||||
|
- label: Windows Server 2019
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Can this tool be installed during the build?
|
||||||
|
description: If so, please provide a description with required steps. This will be automatically formatted into code.
|
||||||
|
render: bash
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Tool installation time in runtime
|
||||||
|
description: How long does it take to install the tool?
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Are you willing to submit a PR?
|
||||||
|
description: We accept contributions!
|
||||||
@@ -1,78 +0,0 @@
|
|||||||
# Adapted from: https://github.com/microsoft/azure-pipelines-tasks/blob/master/.github/workflows/blank.yml
|
|
||||||
# This action labels and assigns newly opened issues
|
|
||||||
|
|
||||||
name: Issue triager
|
|
||||||
on:
|
|
||||||
issues:
|
|
||||||
types: [opened]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
label:
|
|
||||||
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v1
|
|
||||||
|
|
||||||
- uses: damccorm/tag-ur-it@master
|
|
||||||
with:
|
|
||||||
repo-token: "${{ secrets.GITHUB_TOKEN }}"
|
|
||||||
configuration-path: "./triage-rules.yml"
|
|
||||||
|
|
||||||
- uses: actions/github-script@v4
|
|
||||||
id: check-if-spammy
|
|
||||||
name: Check if new issue is spammy
|
|
||||||
with:
|
|
||||||
github-token: ${{secrets.GITHUB_TOKEN}}
|
|
||||||
result-encoding: string
|
|
||||||
script: |
|
|
||||||
const issue = context.payload.issue;
|
|
||||||
const minTitleLength = 2;
|
|
||||||
const titleLength = issue.title.trim().split(' ').length;
|
|
||||||
const isEmptyToolRequest = !!(issue.title.includes('[tool name]') && issue.body.includes('Tool name: <!--- Name -->'));
|
|
||||||
|
|
||||||
if (isEmptyToolRequest || titleLength < minTitleLength) {
|
|
||||||
await github.issues.createComment({
|
|
||||||
owner: context.repo.owner,
|
|
||||||
repo: context.repo.repo,
|
|
||||||
issue_number: issue.number,
|
|
||||||
body: "This issue appears to have been opened accidentally. I'm going to close it now, but feel free to open a new issue or ask any questions in discussions!"
|
|
||||||
});
|
|
||||||
|
|
||||||
await github.issues.update({
|
|
||||||
owner: context.repo.owner,
|
|
||||||
repo: context.repo.repo,
|
|
||||||
labels: ['Invalid'],
|
|
||||||
issue_number: issue.number,
|
|
||||||
state: 'closed'
|
|
||||||
});
|
|
||||||
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
return false;
|
|
||||||
|
|
||||||
- if: ${{ steps.check-if-spammy.outputs.result == 'false' }}
|
|
||||||
uses: actions/github-script@v4
|
|
||||||
name: Assign labels to issue
|
|
||||||
with:
|
|
||||||
github-token: ${{secrets.GITHUB_TOKEN}}
|
|
||||||
script: |
|
|
||||||
const issueLabels = await github.issues.listLabelsOnIssue({
|
|
||||||
issue_number: context.issue.number,
|
|
||||||
owner: context.repo.owner,
|
|
||||||
repo: context.repo.repo
|
|
||||||
});
|
|
||||||
|
|
||||||
const isAnnouncement = issueLabels.data && issueLabels.data
|
|
||||||
.map(label => label.name)
|
|
||||||
.includes('Announcement');
|
|
||||||
|
|
||||||
if (!isAnnouncement) {
|
|
||||||
github.issues.addLabels({
|
|
||||||
issue_number: context.issue.number,
|
|
||||||
owner: context.repo.owner,
|
|
||||||
repo: context.repo.repo,
|
|
||||||
labels: ['needs triage']
|
|
||||||
})
|
|
||||||
}
|
|
||||||
Reference in New Issue
Block a user