Skip to content

Commit 9526660

Browse files
committed
Convert to issue template
1 parent e9c9ad2 commit 9526660

9 files changed

Lines changed: 170 additions & 90 deletions

.github/ISSUE_TEMPLATE/1-report-bug.md

Lines changed: 0 additions & 28 deletions
This file was deleted.
Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
name: '🐛 Bug report'
2+
labels: 'bug'
3+
description: Create a bug report to help us improve
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
**Never report security issues on GitHub or other public channels (Gitter/Twitter/etc.)**
10+
Follow these instruction to report security issues: https://www.jenkins.io/security/#reporting-vulnerabilities
11+
12+
- type: textarea
13+
attributes:
14+
label: Jenkins and plugins versions report
15+
description: |
16+
For easier bug reporting, you can get the full list of plugins with this Groovy script that you can run in **Jenkins > Manage Jenkins > Script Console**:
17+
```groovy
18+
println("Jenkins: ${Jenkins.instance.getVersion()}")
19+
println("OS: ${System.getProperty('os.name')} - ${System.getProperty('os.version')}")
20+
println "---"
21+
22+
Jenkins.instance.pluginManager.plugins
23+
.collect()
24+
.sort { it.getShortName() }
25+
.each {
26+
plugin -> println("${plugin.getShortName()}:${plugin.getVersion()}")
27+
}
28+
return
29+
```
30+
placeholder: |
31+
Jenkins: 2.326
32+
OS: Linux - 3.10.0-1160.45.1.el7.x86_64
33+
---
34+
ace-editor:1.1
35+
ant:1.13
36+
antisamy-markup-formatter:2.5
37+
apache-httpcomponents-client-4-api:4.5.13-1.0
38+
authentication-tokens:1.4
39+
bootstrap4-api:4.6.0-3
40+
bootstrap5-api:5.1.3-4
41+
bouncycastle-api:2.25
42+
...
43+
value: |
44+
<details>
45+
<summary>Environment</summary>
46+
47+
<!-- Paste your environment details below -->
48+
```text
49+
Paste the output here
50+
```
51+
52+
</details>
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
attributes:
58+
label: What Operating System are you using (both controller, and any agents involved in the problem)?
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
attributes:
64+
label: Reproduction steps
65+
description: |
66+
Write bullet-point reproduction steps.
67+
Be explicit about any relevant configuration, jobs, build history, user accounts, etc., redacting confidential information as needed.
68+
The best reproduction steps start with a clean Jenkins install, perhaps a `docker run` command if possible.
69+
Use screenshots where appropriate, copy textual output otherwise. When in doubt, do both.
70+
Include relevant logs, debug if needed - https://www.jenkins.io/doc/book/system-administration/viewing-logs/
71+
placeholder: |
72+
1. Step 1: ...
73+
2. Step 2: ...
74+
validations:
75+
required: true
76+
77+
- type: textarea
78+
attributes:
79+
label: Expected Results
80+
description: What was your expected result?
81+
validations:
82+
required: true
83+
84+
- type: textarea
85+
attributes:
86+
label: Actual Results
87+
description: What was the actual result?
88+
validations:
89+
required: true
90+
91+
- type: textarea
92+
attributes:
93+
label: Anything else?
94+
description: You can provide additional context below.

.github/ISSUE_TEMPLATE/2-feature-request.md

Lines changed: 0 additions & 20 deletions
This file was deleted.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: '🚀 Feature request'
2+
labels: 'enhancement'
3+
description: I have a suggestion
4+
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: What feature do you want to see added?
9+
description: A clear and concise description of your feature request.
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
attributes:
15+
label: Upstream changes
16+
description: Link here any upstream changes that might be relevant to this request
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: '📝 Documentation'
2+
labels: 'documentation'
3+
description: 'Let us know if any documentation is missing or could be improved'
4+
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Describe your use-case which is not covered by existing documentation.
9+
description: If it is easier to submit a documentation patch instead of writing an issue, just do it!
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
attributes:
15+
label: Reference any relevant documentation, other materials or issues/pull requests that can be used for inspiration.

.github/ISSUE_TEMPLATE/3-plugin-compatibility.md

Lines changed: 0 additions & 39 deletions
This file was deleted.
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: "💥 Plugin Compatibility"
2+
labels: plugin-compatibility
3+
description: Create a plugin compatibility issue report
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
To better understand plugin compatibility issues, you can [read more here](../blob/master/docs/COMPATIBILITY.md).
10+
Plugin developers should read our [compatibility guide](../blob/master/docs/PLUGINS.md)
11+
- type: checkboxes
12+
id: checklist
13+
attributes:
14+
label: Checklist
15+
options:
16+
- label: I've checked the existing [dashboard](https://issues.jenkins.io/secure/Dashboard.jspa?selectPageId=18341) for an open issue first
17+
required: true
18+
- label: I've created an issue on the plugins issue tracker, (Jira or GitHub depending on the plugin), use this link for [Jira](https://issues.jenkins-ci.org/secure/CreateIssueDetails!init.jspa?pid=10172&issuetype=1&summary=Cannot+configure+X+plugin+with+JCasC&labels=jcasc-compatibility)
19+
required: true
20+
- label: If the plugin uses Jira for issues you've added the label `jcasc-compatibility`
21+
required: true
22+
- type: input
23+
id: plugin-issue
24+
attributes:
25+
label: Plugin issue link
26+
description: Include a link to where the issue is reported in it's issue tracker
27+
validations:
28+
required: true
29+
- type: input
30+
id: plugin-link
31+
attributes:
32+
label: Plugin GitHub repository link
33+
placeholder: https://github.com/jenkinsci/?
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: error
38+
attributes:
39+
label: Description
40+
placeholder: Describe your issue here...
41+
validations:
42+
required: true
File renamed without changes.

docs/COMPATIBILITY.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ The list of already known issues in the Jenkins issue tracker, are tracked throu
1111

1212
## Reporting Plugin Compatibility issue
1313

14-
Create an issue at [issues.jenkins-ci.org](https://issues.jenkins-ci.org) with the label `jcasc-compatibility` and fill out the details.
14+
Create an issue at [issues.jenkins.io](https://issues.jenkins.io) with the label `jcasc-compatibility` and fill out the details.
1515
[Link to create issue][new-jira-issue]
1616
Create a Github issue for crosslink purposes on this repository.
1717

1818
If you prefer the [new issue for plugin compatibility][new-github-issue] should take you through the entire workflow.
1919

2020
[dashboard]: https://issues.jenkins.io/secure/Dashboard.jspa?selectPageId=18341
21-
[new-jira-issue]: https://issues.jenkins-ci.org/secure/CreateIssueDetails!init.jspa?pid=10172&issuetype=1&summary=Cannot+configure+X+plugin+with+JCasC&labels=jcasc-compatibility
22-
[new-github-issue]: https://github.com/jenkinsci/configuration-as-code-plugin/issues/new?labels=plugin-compatibility&template=3-plugin-compatibility.md
21+
[new-jira-issue]: https://issues.jenkins.io/secure/CreateIssueDetails!init.jspa?pid=10172&issuetype=1&summary=Cannot+configure+X+plugin+with+JCasC&labels=jcasc-compatibility
22+
[new-github-issue]: https://github.com/jenkinsci/configuration-as-code-plugin/issues/new?assignees=&labels=plugin-compatibility&template=4-plugin-compatibility.yml

0 commit comments

Comments
 (0)