Add issue templates

Signed-off-by: Sanjula Ganepola <sanjulagane@gmail.com>
This commit is contained in:
Sanjula Ganepola
2024-11-30 19:46:28 -05:00
parent d032fe2d3d
commit bcd0431e81
4 changed files with 153 additions and 0 deletions

97
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@@ -0,0 +1,97 @@
name: 🚨 Bug Report
description: Report a bug or issue.
labels:
- 'bug'
body:
- type: input
id: github-local-actions-version
attributes:
label: Github Local Actions Version
description: |
What version of `Github Local Actions` are you using? This can be obtained from the standard `Extensions` view.
placeholder: |
v#.#.#
validations:
required: true
- type: input
id: act-version
attributes:
label: Act Version
description: |
What version of `act` are you using? This can be obtained from the `Components` view or by running `act --version`.
placeholder: |
act version #.#.#
validations:
required: true
- type: input
id: github-repository-link
attributes:
label: GitHub Repository Link
description: |
If your GitHub repository is public, provide a link to help us troubleshoot the problem.
placeholder: |
https://github.com/...
validations:
required: false
- type: textarea
id: workflow-content
attributes:
label: Workflow Content
description: |
Share your **entire** workflow here.
placeholder: |
name: My workflow
on: ['push', 'schedule']
jobs:
test:
runs-on: ubuntu-latest
env:
KEY: VAL
[...]
render: yml
validations:
required: false
- type: textarea
id: act-command-used
attributes:
label: Act Command Used
description: |
Share the entire act command which was used. This can be obtained from the VS Code task used to execute the workflow.
If you no longer have the task open, you can select `View Output` from the `History` view and find it on the first line of the log file.
⚠️ Please make sure all sensitive information is removed. ⚠️
placeholder: |
act -P ubuntu-latest=node:12 -v ...
render: sh
validations:
required: false
- type: textarea
id: act-command-output
attributes:
label: Act Command Output
description: |
Copy and paste any relevant log output from the VS Code task or log file. This will be automatically formatted into code, so no need for backticks.
⚠️ Please make sure all sensitive information is removed. ⚠️
placeholder: |
Use `act -v` for verbose output
render: sh
validations:
required: false
- type: textarea
id: bug-description
attributes:
label: Bug Description
description: |
Describe the bug you encountered and share all steps to reproduce it.
validations:
required: true
- type: textarea
id: act-bug-report
attributes:
label: Act Bug Report
description: |
Provide the output of `act --bug-report`
placeholder: |
act --bug-report
render: yml
validations:
required: false

8
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: ✍️ Start a Discussion!
url: https://github.com/SanjulaGanepola/github-local-actions/discussions
about: You can ask for help here.
- name: 🙏 Learn How to Contribute!
url: https://github.com/SanjulaGanepola/github-local-actions/blob/main/CONTRIBUTING.md
about: Check out the contributing guidelines.

View File

@@ -0,0 +1,15 @@
name: 📖 Documentation Issue
description: Report an issue or enhancement regarding the documentation.
labels:
- 'documentation'
body:
- type: textarea
id: description
attributes:
label: Description
description:
label: Description
description: |
Describe the issue or enhancement regarding the documentation.
validations:
required: true

View File

@@ -0,0 +1,33 @@
name: 💡 Feature Request
description: Suggest an idea for this project.
labels:
- 'enhancement'
body:
- type: input
id: github-local-actions-version
attributes:
label: Github Local Actions Version
description: |
What version of `Github Local Actions` are you using? This can be obtained from the standard `Extensions` view.
placeholder: |
v#.#.#
validations:
required: true
- type: input
id: act-version
attributes:
label: Act Version
description: |
What version of `act` are you using? This can be obtained from the `Components` view or by running `act --version`.
placeholder: |
act version #.#.#
validations:
required: true
- type: textarea
id: feature-description
attributes:
label: Feature Description
description: |
Describe the feature that you would like to see.
validations:
required: true