From b562dfafe6ae2c18a60c91c5d1bd9facda964f96 Mon Sep 17 00:00:00 2001 From: Sarah Etter Date: Mon, 11 Apr 2022 15:13:30 -0400 Subject: [PATCH 1/3] chore: switch to more detailed yml based bug report template --- .github/ISSUE_TEMPLATE/bug_report.md | 57 --------- .github/ISSUE_TEMPLATE/bug_report.yml | 166 ++++++++++++++++++++++++++ 2 files changed, 166 insertions(+), 57 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 61f9f192..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: 'Please replace with a clear and descriptive title' -labels: bug -assignees: '' ---- - -Thanks for reporting this bug! - -If this is related to a typo or the documentation being unclear, please click on -the relevant page's `Edit` button (pencil icon) and suggest a correction -instead. - -Please search other issues to make sure this bug has not already been reported. - -Then fill in the sections below. - -**Describe the bug** - -A clear and concise description of what the bug is. - -**Steps to reproduce** - -Step-by-step instructions on how to reproduce the behavior. - -Example: - -1. Type the following command: [...] -2. etc. - -**Expected behavior** - -A clear and concise description of what you expected to happen. - -**Configuration** - -Command line options and/or configuration file, if any. - -**Environment** - -Enter the following command in a terminal and copy/paste its output: - -```bash -npx envinfo --system --binaries --browsers --npmPackages @netlify/plugin-gatsby -``` - -**Screenshots** - -If applicable, add screenshots to help explain your problem. - -**Can you submit a pull request?** - -Yes/No. - -Pull requests are welcome! If you would like to help us fix this bug, please -check our [contributions guidelines](../blob/master/CONTRIBUTING.md). diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..b3c4fb42 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,166 @@ +name: Bug Report +description: Create a report to help us improve +title: '[Bug]: ' +labels: ['type: bug'] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! Using this template makes it a lot easier for us to diagnose your problem, so please fill in as many fields as possible. + + - type: textarea + id: description + attributes: + label: Summary + description: A short description of the problem + placeholder: | + Include what you expected to happen, and what actually happened. + validations: + required: true + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to reproduce + description: Steps to reproduce the behavior + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + - type: input + id: link-to-reproduction + attributes: + label: A link to a reproduction repository + description: + The fastest way to describe your bug is to provide a reproduction + repository. + placeholder: https://github.com/project/link-to-your-reproduction-repo + + - type: input + id: plugin-version + attributes: + label: Plugin version + description: + The version of `@netlify/plugin-gatsby` that you are using. (This is in + the build logs) + placeholder: x.x.x + validations: + required: true + + - type: checkboxes + id: more-info + attributes: + label: More information about your build + options: + - label: I am building using the CLI + - label: I am building using file-based configuration (`netlify.toml`) + - type: dropdown + id: which-os + attributes: + label: What OS are you using? + description: (If you're using the CLI) What OS are you using? + options: + - Windows + - Mac OS + - Linux + - Other + - type: textarea + id: netlify-toml + attributes: + label: Your netlify.toml file + description: + (If you're using file-based config) Please provide a copy of your + `netlify.toml` file. + value: | +
+ `netlify.toml` + + ```toml + # Paste content of your `netlify.toml` file here + ``` + +
+ + - type: textarea + id: gatsby-config + attributes: + label: Configuration + description: + Please provide command line options and/or configuration file, if any. + value: | +
+ `gatsby-config.js` and options + + ``` + # Paste content of your `gatsby-config.js` file, and/or command line options here. Check there is no private info in there. + ``` + +
+ - type: textarea + id: environment + attributes: + label: Environment + description: | + Enter the following command in a terminal and copy/paste its output: + + ```bash + npx envinfo --system --binaries --browsers --npmPackages @netlify/plugin-gatsby + ``` + value: | +
+ Environment + + ``` + # Paste output from `npx envinfo` here. + ``` + +
+ + - type: textarea + id: redirects-file + attributes: + label: Your _redirects file + description: + Please provide a copy of your `_redirects` file if you have one. + value: | +
+ `_redirects` + + ```toml + # Paste content of your `_redirects` file here + ``` + +
+ + - type: textarea + id: build-logs + attributes: + label: Builds logs (or link to your logs) + value: | +
+ Build logs + + ``` + # Paste logs here + ``` + +
+ + - type: textarea + id: function-logs + attributes: + label: Function logs + description: + If it is a runtime error, please provide a copy of the relevant function + logs. + value: | +
+ Function logs + + ``` + # Paste logs here + ``` + +
From 922eb301382f7f921d68319b52ad4ba20fb56efc Mon Sep 17 00:00:00 2001 From: Sarah Etter Date: Tue, 12 Apr 2022 10:14:54 -0400 Subject: [PATCH 2/3] chore: text change Co-authored-by: Matt Kane --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index b3c4fb42..5118466d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -153,7 +153,7 @@ body: attributes: label: Function logs description: - If it is a runtime error, please provide a copy of the relevant function + If it is a runtime error with DSG, SSR or API pages, please provide a copy of the relevant function log logs. value: |
From d636df78b967e2f00ecfa752e83ff9aaba1cf2a4 Mon Sep 17 00:00:00 2001 From: Sarah Etter Date: Tue, 12 Apr 2022 10:16:36 -0400 Subject: [PATCH 3/3] chore: add field to collect gatsby info output --- .github/ISSUE_TEMPLATE/bug_report.yml | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 5118466d..55d9c0b2 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -118,6 +118,26 @@ body:
+ - type: textarea + id: gatsby-info + attributes: + label: Gatsby info + description: | + Enter the following command in a terminal and copy/paste its output: + + ```bash + gatsby info + ``` + value: | +
+ gatsby info + + ``` + # Paste output from `gatsby info` here. + ``` + +
+ - type: textarea id: redirects-file attributes: @@ -153,8 +173,8 @@ body: attributes: label: Function logs description: - If it is a runtime error with DSG, SSR or API pages, please provide a copy of the relevant function log - logs. + If it is a runtime error with DSG, SSR or API pages, please provide a + copy of the relevant function log logs. value: |
Function logs