Skip to content

Commit

Permalink
Issue templates and automatic labelling
Browse files Browse the repository at this point in the history
  • Loading branch information
rafaspadilha committed Jan 31, 2024
1 parent 6ba8bd4 commit be06e30
Show file tree
Hide file tree
Showing 5 changed files with 186 additions and 0 deletions.
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: Bug Report
description: Report a bug encountered in FarmVibes.AI
labels: ["bug"]

body:
- type: markdown
attributes:
value: Thanks for taking the time to fill out this bug report!

- type: dropdown
id: bug-location
attributes:
label: In which step did you encounter the bug?
options:
- FarmVibes.AI setup
- Workflow execution
- Notebook execution
- Documentation
- Other
validations:
required: true

- type: dropdown
id: cluster-type
attributes:
label: Are you using a local or a remote (AKS) FarmVibes.AI cluster?
multiple: true
options:
- Local cluster
- Remote (AKS) cluster
validations:
required: false


- type: textarea
id: bug-description
attributes:
label: Bug description
description: >
Please describe the bug you encountered in as much detail as possible. If you are
encountering an error, please include the full error message, log file content available
in the `logs` folder within the FarmVibes.AI storage path
(default path is `~/.cache/farmvibes-ai/logs` for Linux/macOS, and
`C:\Users\<username>\.cache\farmvibes-ai\logs` for Windows), and the
[`VibeWorkflowRun.reason`](https://microsoft.github.io/farmvibes-ai/docfiles/code/vibe_core_client/client.html#vibe_core.client.VibeWorkflowRun.reason)
field if the error occurred during workflow execution.
validations:
required: false

- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce the problem
description: >
Please describe the steps you took to reproduce the bug. If the issue was encountered
during workflow or notebook execution, please include the workflow/notebook name,
parameters, input geometry and time range.
validations:
required: false

34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/info.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Additional information
description: Request for additional information related to FarmVibes.AI
labels: ["question"]

body:
- type: markdown
attributes:
value: Thanks for taking the time to reach us! Feel free to ask any question related to FarmVibes.AI, we will get back to you as soon as possible.

- type: dropdown
id: info-topic
attributes:
label: Topic
multiple: true
options:
- General question
- Feature request
- Documentation
- FarmVibes.AI setup
- Notebook
- Workflow
- Local cluster
- Remote (AKS) cluster
validations:
required: false

- type: textarea
id: info-request
attributes:
label: Ask away!
placeholder: |
Let us know what is on your mind...
validations:
required: true
37 changes: 37 additions & 0 deletions .github/advanced-issue-labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
policy:
- template: ['bug.yml', 'info.yml']
- section:
- id: [bug-location]
block-list: ['Other']
label:
- name: 'documentation'
keys: ['Documentation']
- name: 'FarmVibes.AI setup'
keys: ['FarmVibes.AI setup']
- name: 'notebooks'
keys: ['Notebook execution']
- name: 'workflows'
keys: ['Workflow execution']
- id: [cluster-type]
label:
- name: 'local cluster'
keys: ['Local cluster']
- name: 'remote cluster'
keys: ['Remote (AKS) cluster']
- id: [info-topic]
block-list: ['General question']
label:
- name: 'enhancement'
keys: ['Feature request']
- name: 'documentation'
keys: ['Documentation']
- name: 'FarmVibes.AI setup'
keys: ['FarmVibes.AI setup']
- name: 'notebooks'
keys: ['Notebook']
- name: 'workflows'
keys: ['Workflow']
- name: 'local cluster'
keys: ['Local cluster']
- name: 'remote cluster'
keys: ['Remote (AKS) cluster']
37 changes: 37 additions & 0 deletions .github/workflows/issue-labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Bug and Info issue labeler
on:
issues:
types: [ opened ]
permissions:
contents: read
jobs:
label_issues:
runs-on: ubuntu-latest
permissions:
# required for all workflows
issues: write
# only required for workflows in private repositories
actions: read
contents: read
steps:
- uses: actions/checkout@v3
- name: Parse bug issue form
uses: stefanbuck/github-issue-parser@v3
id: bug-issue-parser
with:
template-path: .github/ISSUE_TEMPLATE/bug.yml
- name: Set labels based on type
uses: redhat-plumbers-in-action/advanced-issue-labeler@v2
with:
issue-form: ${{ steps.bug-issue-parser.outputs.jsonString }}
token: ${{ secrets.GITHUB_TOKEN }}
- name: Parse additional info issue form
uses: stefanbuck/github-issue-parser@v3
id: info-issue-parser
with:
template-path: .github/ISSUE_TEMPLATE/info.yml
- name: Set labels based on type
uses: redhat-plumbers-in-action/advanced-issue-labeler@v2
with:
issue-form: ${{ steps.info-issue-parser.outputs.jsonString }}
token: ${{ secrets.GITHUB_TOKEN }}
18 changes: 18 additions & 0 deletions .github/workflows/triage-issues.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Triage issue labeler
on:
issues:
types:
- reopened
- opened
jobs:
triage_issues:
runs-on: ubuntu-latest
permissions:
issues: write
steps:
- run: gh issue edit "$NUMBER" --add-label "$LABELS"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
NUMBER: ${{ github.event.issue.number }}
LABELS: triage

0 comments on commit be06e30

Please sign in to comment.