diff --git a/.github/ISSUE_TEMPLATE/1-report-bug.md b/.github/ISSUE_TEMPLATE/1-report-bug.md deleted file mode 100644 index 4ce25317..00000000 --- a/.github/ISSUE_TEMPLATE/1-report-bug.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -name: "🐛 Bug report" -labels: bug -about: Create a bug report to help us improve ---- - - - -### Your checklist for this issue - -🚨 Please review the [guidelines for contributing](../blob/master/docs/CONTRIBUTING.md) to this repository. - -- [ ] Jenkins version - -- [ ] Plugin version - -- [ ] OS - - - -### Description - -Please describe your issue here. diff --git a/.github/ISSUE_TEMPLATE/1-report-bug.yml b/.github/ISSUE_TEMPLATE/1-report-bug.yml new file mode 100644 index 00000000..b09abaf4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-report-bug.yml @@ -0,0 +1,94 @@ +name: '🐛 Bug report' +labels: 'bug' +description: Create a bug report to help us improve + +body: + - type: markdown + attributes: + value: | + **Never report security issues on GitHub or other public channels (Gitter/Twitter/etc.)** + Follow these instruction to report security issues: https://www.jenkins.io/security/#reporting-vulnerabilities + + - type: textarea + attributes: + label: Jenkins and plugins versions report + description: | + 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**: + ```groovy + println("Jenkins: ${Jenkins.instance.getVersion()}") + println("OS: ${System.getProperty('os.name')} - ${System.getProperty('os.version')}") + println "---" + + Jenkins.instance.pluginManager.plugins + .collect() + .sort { it.getShortName() } + .each { + plugin -> println("${plugin.getShortName()}:${plugin.getVersion()}") + } + return + ``` + placeholder: | + Jenkins: 2.326 + OS: Linux - 3.10.0-1160.45.1.el7.x86_64 + --- + ace-editor:1.1 + ant:1.13 + antisamy-markup-formatter:2.5 + apache-httpcomponents-client-4-api:4.5.13-1.0 + authentication-tokens:1.4 + bootstrap4-api:4.6.0-3 + bootstrap5-api:5.1.3-4 + bouncycastle-api:2.25 + ... + value: | +
+ Environment + + + ```text + Paste the output here + ``` + +
+ validations: + required: true + + - type: textarea + attributes: + label: What Operating System are you using (both controller, and any agents involved in the problem)? + validations: + required: true + + - type: textarea + attributes: + label: Reproduction steps + description: | + Write bullet-point reproduction steps. + Be explicit about any relevant configuration, jobs, build history, user accounts, etc., redacting confidential information as needed. + The best reproduction steps start with a clean Jenkins install, perhaps a `docker run` command if possible. + Use screenshots where appropriate, copy textual output otherwise. When in doubt, do both. + Include relevant logs, debug if needed - https://www.jenkins.io/doc/book/system-administration/viewing-logs/ + placeholder: | + 1. Step 1: ... + 2. Step 2: ... + validations: + required: true + + - type: textarea + attributes: + label: Expected Results + description: What was your expected result? + validations: + required: true + + - type: textarea + attributes: + label: Actual Results + description: What was the actual result? + validations: + required: true + + - type: textarea + attributes: + label: Anything else? + description: You can provide additional context below. diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.md b/.github/ISSUE_TEMPLATE/2-feature-request.md deleted file mode 100644 index 1e25f519..00000000 --- a/.github/ISSUE_TEMPLATE/2-feature-request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: "🚀 Feature request" -labels: feature -about: I have a suggestion ---- - -### Your checklist for this issue - -🚨 Please review the [guidelines for contributing](../blob/master/docs/CONTRIBUTING.md) to this repository. - -- [ ] Link to any upstream changes that might be required (for example Jenkins Core pull request) - - - -### Feature Request - -Describe your feature request here. diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.yml b/.github/ISSUE_TEMPLATE/2-feature-request.yml new file mode 100644 index 00000000..e579c909 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature-request.yml @@ -0,0 +1,16 @@ +name: '🚀 Feature request' +labels: 'enhancement' +description: I have a suggestion + +body: + - type: textarea + attributes: + label: What feature do you want to see added? + description: A clear and concise description of your feature request. + validations: + required: true + + - type: textarea + attributes: + label: Upstream changes + description: Link here any upstream changes that might be relevant to this request diff --git a/.github/ISSUE_TEMPLATE/3-documentation.yml b/.github/ISSUE_TEMPLATE/3-documentation.yml new file mode 100644 index 00000000..4fc3b90b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-documentation.yml @@ -0,0 +1,15 @@ +name: '📝 Documentation' +labels: 'documentation' +description: 'Let us know if any documentation is missing or could be improved' + +body: + - type: textarea + attributes: + label: Describe your use-case which is not covered by existing documentation. + description: If it is easier to submit a documentation patch instead of writing an issue, just do it! + validations: + required: true + + - type: textarea + attributes: + label: Reference any relevant documentation, other materials or issues/pull requests that can be used for inspiration. diff --git a/.github/ISSUE_TEMPLATE/3-plugin-compatibility.md b/.github/ISSUE_TEMPLATE/3-plugin-compatibility.md deleted file mode 100644 index 0bb4b9d7..00000000 --- a/.github/ISSUE_TEMPLATE/3-plugin-compatibility.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: "💥 Plugin Compatibility" -labels: plugin-compatibility -about: Create a plugin compatibility issue report ---- - -[jenkins-jira]: https://issues.jenkins-ci.org -[dashboard]: https://issues.jenkins.io/secure/Dashboard.jspa?selectPageId=18341 -[contributing]: ../blob/master/docs/CONTRIBUTING.md -[compatibility]: ../blob/master/docs/COMPATIBILITY.md - -### Your checklist for this issue - -🚨 Please review the [guidelines for contributing][contributing] to this repository. -💡 To better understand plugin compatibility issues, you can [read more here][compatibility] - - - -- [ ] Create an issue on [issues.jenkins-ci.org][jenkins-jira], set the component to the plugin you are reporting it against - -- [ ] Before creating an issue on [Jenkins JIRA][jenkins-jira], check for [an existing one via dashboard][dashboard] - -- [ ] Link to [Jenkins JIRA issue][jenkins-jira] - -- [ ] Ensure [Jenkins JIRA issue][jenkins-jira] has the label `jcasc-compatibility` - -- [ ] Link to plugin's GitHub repository - - - -### Description - -Please describe your issue here. diff --git a/.github/ISSUE_TEMPLATE/4-plugin-compatibility.yml b/.github/ISSUE_TEMPLATE/4-plugin-compatibility.yml new file mode 100644 index 00000000..b1f9135b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4-plugin-compatibility.yml @@ -0,0 +1,42 @@ +name: "💥 Plugin Compatibility" +labels: plugin-compatibility +description: Create a plugin compatibility issue report + +body: + - type: markdown + attributes: + value: | + To better understand plugin compatibility issues, you can read more on our [compatibility](../blob/master/docs/COMPATIBILITY.md) page. + Plugin developers should read our [compatibility guide](../blob/master/docs/PLUGINS.md). + - type: checkboxes + id: checklist + attributes: + label: Checklist + options: + - label: I've checked the existing [dashboard](https://issues.jenkins.io/secure/Dashboard.jspa?selectPageId=18341) for an open issue first + required: true + - 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) + required: true + - label: If the plugin uses Jira for issues you've added the label `jcasc-compatibility` + required: true + - type: input + id: plugin-issue + attributes: + label: Plugin issue link + description: Include a link to where the issue is reported in it's issue tracker + validations: + required: true + - type: input + id: plugin-link + attributes: + label: Plugin GitHub repository link + placeholder: https://github.com/jenkinsci/? + validations: + required: true + - type: textarea + id: error + attributes: + label: Description + placeholder: Describe your issue here... + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/4-support.md b/.github/ISSUE_TEMPLATE/5-question.md similarity index 100% rename from .github/ISSUE_TEMPLATE/4-support.md rename to .github/ISSUE_TEMPLATE/5-question.md diff --git a/docs/COMPATIBILITY.md b/docs/COMPATIBILITY.md index 991fc60c..91c9dfba 100644 --- a/docs/COMPATIBILITY.md +++ b/docs/COMPATIBILITY.md @@ -11,12 +11,12 @@ The list of already known issues in the Jenkins issue tracker, are tracked throu ## Reporting Plugin Compatibility issue -Create an issue at [issues.jenkins-ci.org](https://issues.jenkins-ci.org) with the label `jcasc-compatibility` and fill out the details. +Create an issue at [issues.jenkins.io](https://issues.jenkins.io) with the label `jcasc-compatibility` and fill out the details. [Link to create issue][new-jira-issue] Create a Github issue for crosslink purposes on this repository. If you prefer the [new issue for plugin compatibility][new-github-issue] should take you through the entire workflow. [dashboard]: https://issues.jenkins.io/secure/Dashboard.jspa?selectPageId=18341 -[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 -[new-github-issue]: https://github.com/jenkinsci/configuration-as-code-plugin/issues/new?labels=plugin-compatibility&template=3-plugin-compatibility.md +[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 +[new-github-issue]: https://github.com/jenkinsci/configuration-as-code-plugin/issues/new?assignees=&labels=plugin-compatibility&template=4-plugin-compatibility.yml