Skip to content

Commit c697049

Browse files
RanVakninRanVaknin
authored
Adding workflows and templates (#36)
Co-authored-by: Ran Vaknin <[email protected]>
1 parent b9d2ce5 commit c697049

File tree

7 files changed

+247
-0
lines changed

7 files changed

+247
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
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
62+
- type: input
63+
id: aws-sessionstore-dynamodb-ruby version
64+
attributes:
65+
label: Gem version used
66+
validations:
67+
required: true
68+
- type: input
69+
id: environment
70+
attributes:
71+
label: Environment details (Version of Ruby, OS environment)
72+
validations:
73+
required: true

‎.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/aws-sdk-ruby/discussions/categories/q-a
6+
about: Please ask and answer questions as a discussion thread

‎.github/ISSUE_TEMPLATE/documentation.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: "📕 Documentation Issue"
3+
description: Report an issue in the API Reference documentation or Developer Guide
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
15+
16+
- type: textarea
17+
id: links
18+
attributes:
19+
label: Links
20+
description: |
21+
Include links to affected documentation page(s).
22+
validations:
23+
required: true

‎.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
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
48+
- type: input
49+
id: version
50+
attributes:
51+
label: version of the aws-sessionstore-dynamodb-ruby Gem
52+
validations:
53+
required: true
54+
- type: input
55+
id: environment
56+
attributes:
57+
label: Environment details (OS name and version, etc.)
58+
validations:
59+
required: true

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Closed Issue Message
2+
on:
3+
issues:
4+
types: [closed]
5+
permissions: {}
6+
jobs:
7+
auto_comment:
8+
permissions:
9+
issues: write # to comment on issues
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: aws-actions/closed-issue-message@v1
13+
with:
14+
# These inputs are both required
15+
repo-token: "${{ secrets.GITHUB_TOKEN }}"
16+
message: |
17+
This issue is now closed. Comments on closed issues are hard for our team to see.
18+
If you need more assistance, please open a new issue that references this one.

‎.github/workflows/handle-stale-discussions.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: HandleStaleDiscussions
2+
on:
3+
schedule:
4+
- cron: '0 */4 * * *'
5+
discussion_comment:
6+
types: [created]
7+
8+
jobs:
9+
handle-stale-discussions:
10+
name: Handle stale discussions
11+
runs-on: ubuntu-latest
12+
permissions:
13+
discussions: write
14+
steps:
15+
- name: Stale discussions action
16+
uses: aws-github-ops/handle-stale-discussions@v1
17+
env:
18+
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

‎.github/workflows/stale_issues.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: "Close stale issues"
2+
3+
# Controls when the action will run.
4+
on:
5+
schedule:
6+
- cron: "0 0 * * *"
7+
8+
permissions: {}
9+
jobs:
10+
cleanup:
11+
permissions:
12+
issues: write # to label, comment and close issues
13+
pull-requests: write # to label, comment and close pull requests
14+
15+
runs-on: ubuntu-latest
16+
name: Stale issue job
17+
steps:
18+
- uses: aws-actions/stale-issue-cleanup@v6
19+
with:
20+
# Setting messages to an empty string will cause the automation to skip
21+
# that category
22+
ancient-issue-message: Greetings! We’re closing this issue because it has been open a long time and hasn’t been updated in a while and may not be getting the attention it deserves. We encourage you to check if this is still an issue in the latest release and if you find that this is still a problem, please feel free to comment or open a new issue.
23+
stale-issue-message: This issue has not received a response in 1 week. If you still think there is a problem, please leave a comment to avoid the issue from automatically closing.
24+
stale-pr-message: This PR has not received a response in 1 week. If you still think there is a problem, please leave a comment to avoid the PR from automatically closing.
25+
# These labels are required
26+
stale-issue-label: closing-soon
27+
exempt-issue-label: no-autoclose
28+
stale-pr-label: closing-soon
29+
exempt-pr-label: pr/needs-review
30+
response-requested-label: response-requested
31+
32+
# Don't set closed-for-staleness label to skip closing very old issues
33+
# regardless of label
34+
closed-for-staleness-label: closed-for-staleness
35+
36+
# Issue timing
37+
days-before-stale: 10
38+
days-before-close: 4
39+
days-before-ancient: 36500
40+
41+
# If you don't want to mark a issue as being ancient based on a
42+
# threshold of "upvotes", you can set this here. An "upvote" is
43+
# the total number of +1, heart, hooray, and rocket reactions
44+
# on an issue.
45+
minimum-upvotes-to-exempt: 10
46+
47+
repo-token: ${{ secrets.GITHUB_TOKEN }}
48+
# loglevel: DEBUG
49+
# Set dry-run to true to not perform label or close actions.
50+
# dry-run: true

0 commit comments

Comments
 (0)