Skip to content

Commit 7a0ff5e

Browse files
committed
chore: add GitHub issue templates
Signed-off-by: Rui Chen <rui@chenrui.dev>
1 parent 488ac71 commit 7a0ff5e

File tree

2 files changed

+147
-0
lines changed

2 files changed

+147
-0
lines changed
Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
name: Bug report
2+
description: Report a bug or regression in action-gh-release
3+
title: "[Bug]: "
4+
labels:
5+
- bug
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Before filing:
11+
- confirm the problem still reproduces on the latest release or `master`
12+
- search existing issues for the same behavior
13+
- if the original repository is private, include a minimal public repro, a sanitized workflow snippet, or exact redacted steps a maintainer can follow
14+
- type: checkboxes
15+
id: checks
16+
attributes:
17+
label: Pre-flight checks
18+
options:
19+
- label: I searched existing issues and did not find a duplicate
20+
required: true
21+
- label: I reproduced this with the latest released version or current `master`
22+
required: true
23+
- label: I included a reproducible example or a sanitized/redacted reproduction path if the original repository is private
24+
required: true
25+
- type: input
26+
id: action_version
27+
attributes:
28+
label: action-gh-release version
29+
description: Tag, SHA, or ref used in your workflow
30+
placeholder: v2.5.2
31+
validations:
32+
required: true
33+
- type: dropdown
34+
id: runner
35+
attributes:
36+
label: Runner operating system
37+
options:
38+
- ubuntu-latest
39+
- windows-latest
40+
- macos-latest
41+
- other
42+
validations:
43+
required: true
44+
- type: input
45+
id: target_repository
46+
attributes:
47+
label: Release target repository
48+
description: Fill this in if you set the `repository:` input
49+
placeholder: owner/repo
50+
- type: input
51+
id: repro_reference
52+
attributes:
53+
label: Reproduction repo, gist, or artifact
54+
description: Link a minimal repro repository, gist, run URL, or other shareable artifact if you have one
55+
placeholder: https://github.com/owner/repro-repo
56+
- type: textarea
57+
id: workflow
58+
attributes:
59+
label: Workflow snippet
60+
description: Include the relevant `uses:` step and inputs. If the original repo is private, paste a sanitized version here.
61+
render: yaml
62+
- type: textarea
63+
id: expected
64+
attributes:
65+
label: Expected behavior
66+
validations:
67+
required: true
68+
- type: textarea
69+
id: actual
70+
attributes:
71+
label: Actual behavior
72+
validations:
73+
required: true
74+
- type: textarea
75+
id: reproduce
76+
attributes:
77+
label: Steps to reproduce
78+
description: Include tags, matrix/concurrency details, and any repo rules involved. If the original repo is private, describe the smallest setup a maintainer can recreate locally or in a throwaway repo.
79+
placeholder: |
80+
1. Trigger workflow with ...
81+
2. Action creates ...
82+
3. Action fails with ...
83+
validations:
84+
required: true
85+
- type: textarea
86+
id: logs
87+
attributes:
88+
label: Relevant logs
89+
description: Paste the relevant error output or run URL
90+
render: shell
91+
validations:
92+
required: true
93+
- type: textarea
94+
id: additional
95+
attributes:
96+
label: Additional context
97+
description: Any extra environment, token, ruleset, or asset details
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Feature request
2+
description: Propose an enhancement or new capability for action-gh-release
3+
title: "[Feature]: "
4+
labels:
5+
- enhancement
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Use this template for new capabilities, behavior changes, or ergonomics improvements.
11+
If you are reporting something broken, use the bug report template instead.
12+
- type: checkboxes
13+
id: checks
14+
attributes:
15+
label: Pre-flight checks
16+
options:
17+
- label: I searched existing issues and did not find a duplicate request
18+
required: true
19+
- label: This is not a bug report for existing behavior
20+
required: true
21+
- type: textarea
22+
id: problem
23+
attributes:
24+
label: Problem to solve
25+
description: What workflow pain point or gap are you trying to address?
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: proposal
30+
attributes:
31+
label: Proposed solution
32+
description: Describe the behavior, input, or output you want
33+
validations:
34+
required: true
35+
- type: textarea
36+
id: workflow
37+
attributes:
38+
label: Example workflow snippet
39+
description: Show how you would expect to use this
40+
render: yaml
41+
- type: textarea
42+
id: alternatives
43+
attributes:
44+
label: Alternatives considered
45+
description: Workarounds or other approaches you evaluated
46+
- type: textarea
47+
id: impact
48+
attributes:
49+
label: Why this belongs in action-gh-release
50+
description: Explain the user impact or why this should live in the action rather than in workflow glue

0 commit comments

Comments
 (0)