Skip to content

Commit 2fd1c82

Browse files
peterwoodworthpeterwoodworth
authored
chore: add issue templates and actions (#507)
* chore: add issue templates and actions * chore: add issue templates and actions
1 parent b76492e commit 2fd1c82

File tree

7 files changed

+201
-0
lines changed

7 files changed

+201
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
name: "🐛 Bug Report"
3+
description: Report a bug
4+
title: "short issue description"
5+
labels: [bug, needs-triage]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Describe the bug
12+
description: What is the problem? A clear and concise description of the bug.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: expected
17+
attributes:
18+
label: Expected Behavior
19+
description: |
20+
What did you expect to happen?
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: current
25+
attributes:
26+
label: Current Behavior
27+
description: |
28+
What actually happened?
29+
30+
Please include full errors, uncaught exceptions, stack traces, and relevant logs.
31+
If service responses are relevant, please include wire logs.
32+
validations:
33+
required: true
34+
- type: textarea
35+
id: reproduction
36+
attributes:
37+
label: Reproduction Steps
38+
description: |
39+
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
40+
For more complex issues provide a repo with the smallest sample that reproduces the bug.
41+
42+
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
43+
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.
44+
validations:
45+
required: true
46+
- type: textarea
47+
id: solution
48+
attributes:
49+
label: Possible Solution
50+
description: |
51+
Suggest a fix/reason for the bug
52+
validations:
53+
required: false
54+
- type: textarea
55+
id: context
56+
attributes:
57+
label: Additional Information/Context
58+
description: |
59+
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.
60+
validations:
61+
required: false

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
blank_issues_enabled: false
3+
contact_links:
4+
- name: 💬 General Question
5+
url: https://github.com/aws-actions/configure-aws-credentials/discussions/categories/q-a
6+
about: Please ask and answer questions as a discussion thread

‎.github/ISSUE_TEMPLATE/documentation.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: "📕 Documentation Issue"
3+
description: Report an issue in the README or a suggestion to improve documentation
4+
title: "short issue description"
5+
labels: [documentation, needs-triage]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Describe the issue
12+
description: A clear and concise description of the issue.
13+
validations:
14+
required: true

‎.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: 🚀 Feature Request
3+
description: Suggest an idea for this project
4+
title: "short issue description"
5+
labels: [feature-request, needs-triage]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Describe the feature
12+
description: A clear and concise description of the feature you are proposing.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: use-case
17+
attributes:
18+
label: Use Case
19+
description: |
20+
Why do you need this feature? For example: "I'm always frustrated when..."
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: solution
25+
attributes:
26+
label: Proposed Solution
27+
description: |
28+
Suggest how to implement the addition or change. Please include prototype/workaround/sketch/reference implementation.
29+
validations:
30+
required: false
31+
- type: textarea
32+
id: other
33+
attributes:
34+
label: Other Information
35+
description: |
36+
Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc.
37+
validations:
38+
required: false
39+
- type: checkboxes
40+
id: ack
41+
attributes:
42+
label: Acknowledgements
43+
options:
44+
- label: I may be able to implement this feature request
45+
required: false
46+
- label: This feature might incur a breaking change
47+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,8 @@
22

33
*Description of changes:*
44

5+
---
6+
7+
* [ ] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws-actions/configure-aws-credentials/blob/master/CONTRIBUTING.md)
58

69
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

‎.github/workflows/close-stale-issues.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: "Close Stale Issues"
2+
3+
# Controls when the action will run.
4+
on:
5+
workflow_dispatch:
6+
schedule:
7+
- cron: "0 */4 * * *"
8+
9+
jobs:
10+
cleanup:
11+
permissions:
12+
issues: write
13+
contents: read
14+
pull-requests: write
15+
runs-on: ubuntu-latest
16+
name: Stale issue job
17+
steps:
18+
- uses: aws-actions/stale-issue-cleanup@v5
19+
with:
20+
# Setting messages to an empty string will cause the automation to skip
21+
# that category
22+
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.
23+
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.
24+
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.
25+
26+
# These labels are required
27+
stale-issue-label: closing-soon
28+
exempt-issue-labels: no-autoclose
29+
stale-pr-label: closing-soon
30+
exempt-pr-labels: no-autoclose
31+
response-requested-label: response-requested
32+
33+
# Don't set closed-for-staleness label to skip closing very old issues
34+
# regardless of label
35+
closed-for-staleness-label: closed-for-staleness
36+
37+
# Issue timing
38+
days-before-stale: 5
39+
days-before-close: 2
40+
days-before-ancient: 365
41+
42+
# If you don't want to mark a issue as being ancient based on a
43+
# threshold of "upvotes", you can set this here. An "upvote" is
44+
# the total number of +1, heart, hooray, and rocket reactions
45+
# on an issue.
46+
minimum-upvotes-to-exempt: 5
47+
48+
repo-token: ${{ secrets.GITHUB_TOKEN }}
49+
loglevel: DEBUG
50+
# Set dry-run to true to not perform label or close actions.
51+
dry-run: false

‎.github/workflows/closed-issue-message.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Closed Issue Message
2+
on:
3+
issues:
4+
types: [closed]
5+
jobs:
6+
auto_comment:
7+
permissions:
8+
issues: write
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: aws-actions/closed-issue-message@v1
12+
with:
13+
# These inputs are both required
14+
repo-token: "${{ secrets.GITHUB_TOKEN }}"
15+
message: |
16+
### ⚠️Comment Visibility Warning⚠️
17+
Comments on closed issues are hard for our team to see.
18+
If you need more assistance, please either tag a team member or open a new issue that references this one.
19+
If you wish to keep having a conversation with other community members under this issue feel free to do so.

0 commit comments

Comments
 (0)