Skip to content

Commit 126506a

Browse files
jkroepkejkroepke
committed
chore: add templates
Signed-off-by: Jan-Otto Kröpke <mail@jkroepke.de>
1 parent ebcd772 commit 126506a

5 files changed

Lines changed: 244 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yaml‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
name: 🐞 Bug
2+
description: Something is not working as indended.
3+
labels: [ 🐞 bug ]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report!
9+
10+
Before you submit this issue, please make sure you have read the documentation and searched for similar issues.
11+
If you have done that, please fill out the template below.
12+
13+
- type: textarea
14+
attributes:
15+
label: Current Behavior
16+
description: A concise description of what you're experiencing.
17+
placeholder: |
18+
When I do <X>, <Y> happens and I see the error message attached below:
19+
```...```
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
attributes:
25+
label: Expected Behavior
26+
description: A concise description of what you expected to happen.
27+
placeholder: When I do <X>, <Z> should happen instead.
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
attributes:
33+
label: Steps To Reproduce
34+
description: Steps to reproduce the behavior.
35+
placeholder: |
36+
1. In this environment...
37+
2. With this config...
38+
3. Run '...'
39+
4. See error...
40+
render: Markdown
41+
validations:
42+
required: false
43+
44+
- type: markdown
45+
attributes:
46+
value: Please not that openvpn-auth-oauth2 requires an OpenVPN server version 2.6.2 or higher.
47+
48+
- type: textarea
49+
attributes:
50+
label: Environment
51+
description: |
52+
examples:
53+
- **openvpn-auth-oauth2 Version**: 1.5.1
54+
- **OpenVPN Server Version**: 2.6.2
55+
- **Server OS**: Linux
56+
- **OpenVPN Client (flavor, OS)**: Tunnelblick 4.0.0beta10 / MacOS
57+
- **OIDC Provider**: Entra ID
58+
value: |
59+
- openvpn-auth-oauth2 Version:
60+
- OpenVPN Server Version:
61+
- Server OS:
62+
- OpenVPN Client (flavor, OS):
63+
- OIDC Provider:
64+
validations:
65+
required: true
66+
67+
- type: textarea
68+
attributes:
69+
label: openvpn-auth-oauth2 logs
70+
description: |
71+
Log of openvpn-auth-oauth2. Output of `journalctl -flu openvpn-auth-oauth2` and `dmesg | grep openvpn`, if openvpn-auth-oauth2 is installed as linux package.
72+
⚠️ Without proving logs, I unable to assist here. ⚠️
73+
render: shell
74+
validations:
75+
required: true
76+
77+
- type: textarea
78+
attributes:
79+
label: openvpn server logs
80+
description: |
81+
Log of openvpn server
82+
render: shell
83+
validations:
84+
required: false
85+
86+
- type: textarea
87+
attributes:
88+
label: Anything else?
89+
description: |
90+
Links? References? Anything that will give us more context about the issue you are encountering!
91+
92+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
93+
validations:
94+
required: false
95+
96+
- type: checkboxes
97+
id: documentation
98+
attributes:
99+
label: Preflight Checklist
100+
options:
101+
- required: true
102+
#language=markdown
103+
label: |
104+
I could not find a solution in the [documentation](https://github.com/jkroepke/openvpn-auth-oauth2/wiki),
105+
the [FAQ](https://github.com/jkroepke/openvpn-auth-oauth2/wiki/FAQ), the existing issues or discussions.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/enhancement.yaml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: ✨ Enhancement / Feature / Task
2+
description: Some feature is missing or incomplete.
3+
labels: [ ✨ enhancement ]
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: Problem Statement
8+
description: Without specifying a solution, describe what the project is missing today.
9+
placeholder: |
10+
The rotating project logo has a fixed size and color.
11+
There is no way to make it larger and more shiny.
12+
validations:
13+
required: false
14+
- type: textarea
15+
attributes:
16+
label: Proposed Solution
17+
description: Describe the proposed solution to the problem above.
18+
placeholder: |
19+
- Implement 2 new flags CLI: ```--logo-color=FFD700``` and ```--logo-size=100```
20+
- Let these flags control the size of the rotating project logo.
21+
validations:
22+
required: false
23+
- type: textarea
24+
attributes:
25+
label: Additional information
26+
placeholder: |
27+
We considered adjusting the logo size to the phase of the moon, but there was no
28+
reliable data source in air-gapped environments.
29+
validations:
30+
required: false
31+
- type: textarea
32+
attributes:
33+
label: Acceptance Criteria
34+
placeholder: |
35+
- [ ] As a user, I can control the size of the rotating logo using a CLI flag.
36+
- [ ] As a user, I can control the color of the rotating logo using a CLI flag.
37+
- [ ] Defaults are reasonably set.
38+
- [ ] New settings are appropriately documented.
39+
- [ ] No breaking change for current users of the rotating logo feature.
40+
validations:
41+
required: false
42+
43+
- type: checkboxes
44+
id: documentation
45+
attributes:
46+
label: Preflight Checklist
47+
options:
48+
- required: true
49+
#language=markdown
50+
label: |
51+
I could not find a solution in the [documentation](https://github.com/jkroepke/openvpn-auth-oauth2/wiki),
52+
the [FAQ](https://github.com/jkroepke/openvpn-auth-oauth2/wiki/FAQ), the existing issues or discussions.

‎.github/ISSUE_TEMPLATE/question.yaml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: ❓ Question
2+
description: Something is not clear.
3+
labels: [ ❓ question ]
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: Problem Statement
8+
description: Without specifying a solution, describe what the project is missing today.
9+
placeholder: |
10+
The rotating project logo has a fixed size and color.
11+
There is no way to make it larger and more shiny.
12+
validations:
13+
required: false
14+
15+
- type: textarea
16+
attributes:
17+
label: openvpn-auth-oauth2 logs
18+
description: |
19+
Log of openvpn-auth-oauth2. Output of `journalctl -flu openvpn-auth-oauth2` and `dmesg | grep openvpn`, if openvpn-auth-oauth2 is installed as linux package.
20+
⚠️ Without proving logs, I unable to assist in case of issues. ⚠️
21+
render: shell
22+
validations:
23+
required: true
24+
25+
- type: markdown
26+
attributes:
27+
value: Please not that openvpn-auth-oauth2 requires an OpenVPN server version 2.6.2 or higher.
28+
29+
- type: textarea
30+
attributes:
31+
label: Environment
32+
description: |
33+
examples:
34+
- **openvpn-auth-oauth2 Version**: 1.5.1
35+
- **OpenVPN Server Version**: 2.6.2
36+
- **Server OS**: Linux
37+
- **OpenVPN Client (flavor, OS)**: Tunnelblick 4.0.0beta10 / MacOD
38+
value: |
39+
- openvpn-auth-oauth2 Version:
40+
- OpenVPN Server Version:
41+
- Server OS:
42+
- OpenVPN Client (flavor, OS):
43+
validations:
44+
required: false
45+
46+
- type: checkboxes
47+
id: documentation
48+
attributes:
49+
label: Preflight Checklist
50+
options:
51+
- required: true
52+
#language=markdown
53+
label: |
54+
I could not find a solution in the [documentation](https://github.com/jkroepke/openvpn-auth-oauth2/wiki),
55+
the [FAQ](https://github.com/jkroepke/openvpn-auth-oauth2/wiki/FAQ), the existing issues or discussions.

‎.github/workflows/pr-check.yaml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Validate Pull Request
2+
on:
3+
pull_request:
4+
types:
5+
- opened
6+
- reopened
7+
- synchronize
8+
- labeled
9+
- unlabeled
10+
11+
jobs:
12+
required-labels-missing:
13+
name: required labels missing
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: check
17+
if: >-
18+
!contains(github.event.pull_request.labels.*.name, '💥 breaking-change')
19+
&& !contains(github.event.pull_request.labels.*.name, '✨ enhancement')
20+
&& !contains(github.event.pull_request.labels.*.name, '🐞 bug')
21+
&& !contains(github.event.pull_request.labels.*.name, '📖 docs')
22+
&& !contains(github.event.pull_request.labels.*.name, 'chore')
23+
&& !contains(github.event.pull_request.labels.*.name, '🛠️ dependencies')
24+
run: >-
25+
echo One of the following labels is missing on this PR:
26+
breaking-change
27+
enhancement
28+
bug
29+
docs
30+
chore
31+
&& exit 1

0 commit comments

Comments
 (0)