Skip to content

Commit

Permalink
Convert issue and bug templates to use forms
Browse files Browse the repository at this point in the history
Signed-off-by: Marc Handalian <marc.handalian@gmail.com>
  • Loading branch information
mch2 committed Dec 11, 2023
1 parent a2f792d commit 5102640
Show file tree
Hide file tree
Showing 5 changed files with 176 additions and 52 deletions.
33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/bug_template.md

This file was deleted.

86 changes: 86 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
name: 🐛 Bug report
description: Create a report to help us improve
title: "[BUG] <title>"
labels: ['bug, untriaged']
body:
- type: textarea
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true
- type: dropdown
attributes:
label: Related component
description: Choose a specific OpenSearch component your bug belongs to. If you are unsure which to select or if the component is not present, select "Other".
multiple: false
options:
- Other
- Build
- Clients
- Cluster Manager
- Extensions
- Indexing:Performance
- Indexing:Replication
- Indexing
- Libraries
- Plugins
- Search:Aggregations
- Search:Performance
- Search:Query Capabilities
- Search:Query Insights
- Search:Relevance
- Search:Remote Search
- Search:Resiliency
- Search:Searchable Snapshots
- Search
- Storage:Durability
- Storage:Performance
- Storage:Remote
- Storage:Snapshots
- Storage
validations:
required: true
- type: textarea
attributes:
label: To Reproduce
description: Steps to reproduce the behavior.
value: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: Documents, Screenshots
description: If applicable, please attach more information in this area, like log files or screenshoots, to help debug your problem.
validations:
required: false
- type: textarea
attributes:
label: Host/Environment
value: |
- OS: [e.g. iOS]
- Version [e.g. 22]
validations:
required: false
- type: textarea
attributes:
label: Plugins
description: Please list all plugins currently enabled.
validations:
required: false
- type: textarea
attributes:
label: Additional context
description: Add any other context about the problem here.
validations:
required: false
19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: 🎆 Feature request
description: Suggest an idea for this project
title: '[Feature Request] <title>'
labels: ['enhancement, untriaged']
body:
- type: textarea
attributes:
label: Is your feature request related to a problem? Please describe
description: A clear and concise description of what the problem is.
placeholder: Ex. I'm always frustrated when [...]
validations:
required: true
- type: textarea
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: dropdown
attributes:
label: Related component
description: Choose a specific OpenSearch component your feature request belongs to. If you are unsure of which component to select or if the component is not present, select "Other".
multiple: false
options:
- Other
- Build
- Clients
- Cluster Manager
- Extensions
- Indexing:Performance
- Indexing:Replication
- Indexing
- Libraries
- Plugins
- Search:Aggregations
- Search:Performance
- Search:Query Capabilities
- Search:Query Insights
- Search:Relevance
- Search:Remote Search
- Search:Resiliency
- Search:Searchable Snapshots
- Search
- Storage:Durability
- Storage:Performance
- Storage:Remote
- Storage:Snapshots
- Storage
validations:
required: true
- type: textarea
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false
- type: textarea
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
validations:
required: false
28 changes: 28 additions & 0 deletions .github/workflows/triage.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Auto triage based on the component label in issue

on:
issues:
types: [opened]

jobs:
apply-label:
if: github.repository == 'opensearch-project/OpenSearch'
runs-on: ubuntu-latest
steps:
- uses: actions/github-script@v7
with:
script: |
const { issue, repository } = context.payload;
const { number, body } = issue;
const { owner, name } = repository;
const regex = /###\sRelated\scomponent\n\n(\w*)\n/gm;
let match;
while ( ( match = regex.exec( body ) ) ) {
const [ , component_label ] = match;
await github.rest.issues.addLabels( {
owner: owner.login,
repo: name,
issue_number: number,
labels: [ `${ component_label }` ],
} );
}

0 comments on commit 5102640

Please sign in to comment.