chore: add issue templates and actions (#507)
* chore: add issue templates and actions * chore: add issue templates and actions
This commit is contained in:
parent
b76492e92a
commit
2fd1c82a69
7 changed files with 201 additions and 0 deletions
61
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
61
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
|
|
@ -0,0 +1,61 @@
|
||||||
|
---
|
||||||
|
name: "🐛 Bug Report"
|
||||||
|
description: Report a bug
|
||||||
|
title: "short issue description"
|
||||||
|
labels: [bug, needs-triage]
|
||||||
|
assignees: []
|
||||||
|
body:
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: Describe the bug
|
||||||
|
description: What is the problem? A clear and concise description of the bug.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: expected
|
||||||
|
attributes:
|
||||||
|
label: Expected Behavior
|
||||||
|
description: |
|
||||||
|
What did you expect to happen?
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: current
|
||||||
|
attributes:
|
||||||
|
label: Current Behavior
|
||||||
|
description: |
|
||||||
|
What actually happened?
|
||||||
|
|
||||||
|
Please include full errors, uncaught exceptions, stack traces, and relevant logs.
|
||||||
|
If service responses are relevant, please include wire logs.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: reproduction
|
||||||
|
attributes:
|
||||||
|
label: Reproduction Steps
|
||||||
|
description: |
|
||||||
|
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
|
||||||
|
For more complex issues provide a repo with the smallest sample that reproduces the bug.
|
||||||
|
|
||||||
|
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
|
||||||
|
The code sample should be an SSCCE. See http://sscce.org/ for details. In short, please provide a code sample that we can copy/paste, run and reproduce.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: solution
|
||||||
|
attributes:
|
||||||
|
label: Possible Solution
|
||||||
|
description: |
|
||||||
|
Suggest a fix/reason for the bug
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
id: context
|
||||||
|
attributes:
|
||||||
|
label: Additional Information/Context
|
||||||
|
description: |
|
||||||
|
Anything else that might be relevant for troubleshooting this bug. Providing context helps us come up with a solution that is most useful in the real world.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
6
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
6
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
---
|
||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: 💬 General Question
|
||||||
|
url: https://github.com/aws-actions/configure-aws-credentials/discussions/categories/q-a
|
||||||
|
about: Please ask and answer questions as a discussion thread
|
||||||
14
.github/ISSUE_TEMPLATE/documentation.yml
vendored
Normal file
14
.github/ISSUE_TEMPLATE/documentation.yml
vendored
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
---
|
||||||
|
name: "📕 Documentation Issue"
|
||||||
|
description: Report an issue in the README or a suggestion to improve documentation
|
||||||
|
title: "short issue description"
|
||||||
|
labels: [documentation, needs-triage]
|
||||||
|
assignees: []
|
||||||
|
body:
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: Describe the issue
|
||||||
|
description: A clear and concise description of the issue.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
47
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
Normal file
47
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
Normal file
|
|
@ -0,0 +1,47 @@
|
||||||
|
---
|
||||||
|
name: 🚀 Feature Request
|
||||||
|
description: Suggest an idea for this project
|
||||||
|
title: "short issue description"
|
||||||
|
labels: [feature-request, needs-triage]
|
||||||
|
assignees: []
|
||||||
|
body:
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: Describe the feature
|
||||||
|
description: A clear and concise description of the feature you are proposing.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: use-case
|
||||||
|
attributes:
|
||||||
|
label: Use Case
|
||||||
|
description: |
|
||||||
|
Why do you need this feature? For example: "I'm always frustrated when..."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: solution
|
||||||
|
attributes:
|
||||||
|
label: Proposed Solution
|
||||||
|
description: |
|
||||||
|
Suggest how to implement the addition or change. Please include prototype/workaround/sketch/reference implementation.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
id: other
|
||||||
|
attributes:
|
||||||
|
label: Other Information
|
||||||
|
description: |
|
||||||
|
Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: checkboxes
|
||||||
|
id: ack
|
||||||
|
attributes:
|
||||||
|
label: Acknowledgements
|
||||||
|
options:
|
||||||
|
- label: I may be able to implement this feature request
|
||||||
|
required: false
|
||||||
|
- label: This feature might incur a breaking change
|
||||||
|
required: false
|
||||||
3
.github/PULL_REQUEST_TEMPLATE.md
vendored
3
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
|
@ -2,5 +2,8 @@
|
||||||
|
|
||||||
*Description of changes:*
|
*Description of changes:*
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
* [ ] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws-actions/configure-aws-credentials/blob/master/CONTRIBUTING.md)
|
||||||
|
|
||||||
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
|
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
|
||||||
|
|
|
||||||
51
.github/workflows/close-stale-issues.yml
vendored
Normal file
51
.github/workflows/close-stale-issues.yml
vendored
Normal file
|
|
@ -0,0 +1,51 @@
|
||||||
|
name: "Close Stale Issues"
|
||||||
|
|
||||||
|
# Controls when the action will run.
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
schedule:
|
||||||
|
- cron: "0 */4 * * *"
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
cleanup:
|
||||||
|
permissions:
|
||||||
|
issues: write
|
||||||
|
contents: read
|
||||||
|
pull-requests: write
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
name: Stale issue job
|
||||||
|
steps:
|
||||||
|
- uses: aws-actions/stale-issue-cleanup@v5
|
||||||
|
with:
|
||||||
|
# Setting messages to an empty string will cause the automation to skip
|
||||||
|
# that category
|
||||||
|
ancient-issue-message: This issue has not received any attention in 1 year. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.
|
||||||
|
stale-issue-message: This issue has not received a response in a while. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.
|
||||||
|
stale-pr-message: This PR has not received a response in a while. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.
|
||||||
|
|
||||||
|
# These labels are required
|
||||||
|
stale-issue-label: closing-soon
|
||||||
|
exempt-issue-labels: no-autoclose
|
||||||
|
stale-pr-label: closing-soon
|
||||||
|
exempt-pr-labels: no-autoclose
|
||||||
|
response-requested-label: response-requested
|
||||||
|
|
||||||
|
# Don't set closed-for-staleness label to skip closing very old issues
|
||||||
|
# regardless of label
|
||||||
|
closed-for-staleness-label: closed-for-staleness
|
||||||
|
|
||||||
|
# Issue timing
|
||||||
|
days-before-stale: 5
|
||||||
|
days-before-close: 2
|
||||||
|
days-before-ancient: 365
|
||||||
|
|
||||||
|
# If you don't want to mark a issue as being ancient based on a
|
||||||
|
# threshold of "upvotes", you can set this here. An "upvote" is
|
||||||
|
# the total number of +1, heart, hooray, and rocket reactions
|
||||||
|
# on an issue.
|
||||||
|
minimum-upvotes-to-exempt: 5
|
||||||
|
|
||||||
|
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
loglevel: DEBUG
|
||||||
|
# Set dry-run to true to not perform label or close actions.
|
||||||
|
dry-run: false
|
||||||
19
.github/workflows/closed-issue-message.yml
vendored
Normal file
19
.github/workflows/closed-issue-message.yml
vendored
Normal file
|
|
@ -0,0 +1,19 @@
|
||||||
|
name: Closed Issue Message
|
||||||
|
on:
|
||||||
|
issues:
|
||||||
|
types: [closed]
|
||||||
|
jobs:
|
||||||
|
auto_comment:
|
||||||
|
permissions:
|
||||||
|
issues: write
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: aws-actions/closed-issue-message@v1
|
||||||
|
with:
|
||||||
|
# These inputs are both required
|
||||||
|
repo-token: "${{ secrets.GITHUB_TOKEN }}"
|
||||||
|
message: |
|
||||||
|
### ⚠️Comment Visibility Warning⚠️
|
||||||
|
Comments on closed issues are hard for our team to see.
|
||||||
|
If you need more assistance, please either tag a team member or open a new issue that references this one.
|
||||||
|
If you wish to keep having a conversation with other community members under this issue feel free to do so.
|
||||||
Loading…
Add table
Add a link
Reference in a new issue