From 371c73fb636483f56ea43bc306a939ebba84db8e Mon Sep 17 00:00:00 2001 From: Matt Schile Date: Wed, 25 Jan 2023 09:27:57 -0700 Subject: [PATCH] chore: adding memory issue template (#25559) Co-authored-by: Emily Rohrbough --- .github/ISSUE_TEMPLATE/1-bug-report.yml | 2 +- .github/ISSUE_TEMPLATE/2-memory-issue.yml | 81 +++++++++++++++++++ ...-install-issue.yml => 3-install-issue.yml} | 4 +- .../{3-feature.yml => 4-feature.yml} | 4 +- .../{4-flaky-test.yml => 5-flaky-test.yml} | 2 +- 5 files changed, 87 insertions(+), 6 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/2-memory-issue.yml rename .github/ISSUE_TEMPLATE/{2-install-issue.yml => 3-install-issue.yml} (92%) rename .github/ISSUE_TEMPLATE/{3-feature.yml => 4-feature.yml} (79%) rename .github/ISSUE_TEMPLATE/{4-flaky-test.yml => 5-flaky-test.yml} (89%) diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yml b/.github/ISSUE_TEMPLATE/1-bug-report.yml index d345678e3644..8ddb5c5ef465 100644 --- a/.github/ISSUE_TEMPLATE/1-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/1-bug-report.yml @@ -4,7 +4,7 @@ body: - type: markdown attributes: value: | - Have a question? 👉 [Start a new discussion](https://github.com/cypress-io/cypress/discussions) or [ask in chat](https://on.cypress.io/discord). + Have a question? 👉 [Ask in chat](https://on.cypress.io/discord) or [start a new discussion](https://github.com/cypress-io/cypress/discussions). - type: textarea id: current-behavior attributes: diff --git a/.github/ISSUE_TEMPLATE/2-memory-issue.yml b/.github/ISSUE_TEMPLATE/2-memory-issue.yml new file mode 100644 index 000000000000..f1435039d206 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-memory-issue.yml @@ -0,0 +1,81 @@ +name: "💾 Memory issue report" +description: Report a memory issue found while using Cypress. +body: + - type: markdown + attributes: + value: | + Have a question? 👉 [Ask in chat](https://on.cypress.io/discord) or [start a new discussion](https://github.com/cypress-io/cypress/discussions). + + Prior to logging a memory issue, please make sure you are running the latest version of Cypress and have enabled [`experimentalMemoryManagement`](https://on.cypress.io/experiments) for Chromium-based browsers (introduced in Cypress 12.4.0). + + If you are running in `cypress open` mode, you can also try lowering [`numTestsKeptInMemory`](https://docs.cypress.io/guides/references/configuration#Options) in your config file. + + If you are still experiencing the issue, please fill out the following information. + - type: textarea + id: reproduction + attributes: + label: Test code to reproduce + description: Please provide a failing test or repo we can run. You can fork [this repo](https://github.com/cypress-io/cypress-test-tiny), set up a failing test, then link to your fork. If you have never done this before, watch [this video](https://youtu.be/NnriKHmj5T8) for example. + placeholder: Here is my failing test code and the app code to run the tests on... + validations: + required: true + - type: dropdown + id: mode + attributes: + label: Cypress Mode + description: What mode of Cypress are you running? + options: + - `cypress run` + - `cypress open` + - both modes + validations: + required: true + - type: input + id: version + attributes: + label: Cypress Version + description: What version of Cypress are you running? Run `cypress version` to see your current version. If possible, please update Cypress to the latest version first. + placeholder: ex. 10.3.1 + validations: + required: true + - type: input + id: browser + attributes: + label: Browser Version + description: What browser(s) is Cypress running against when you are encountering your problem? The more specific the better. ie Chrome 109.0.5414.87 or Firefox 107.0 + placeholder: ex. Chrome 109.0.5414.87 + validations: + required: true + - type: input + id: node-version + attributes: + label: Node version + description: What version of node.js are you using to run Cypress? + placeholder: ex. v16.16.0 + validations: + required: true + - type: input + id: os + attributes: + label: Operating System + description: What operating system is Cypress running on when you are encountering your problem? The more specific the better. ie macOS 12.4 or Windows 10.0.19044.1889 + placeholder: ex. macOS 12.4 + validations: + required: true + - type: textarea + id: debug-logs + attributes: + label: Memory Debug Logs + description: | + If running a Chromium-based browser, please set the `CYPRESS_INTERNAL_MEMORY_SAVE_STATS` environment variable to `1` or `true` and include the `cypress\logs\memory\.json` file here. + + Alternatively, you can run Cypress in [debug mode](https://docs.cypress.io/guides/references/troubleshooting#Print-DEBUG-logs) setting `DEBUG=cypress*memory` and include the entire set of logs here. + placeholder: Debug logging output + render: shell + validations: + required: false + - type: textarea + id: other + attributes: + label: Other + placeholder: Any other details? diff --git a/.github/ISSUE_TEMPLATE/2-install-issue.yml b/.github/ISSUE_TEMPLATE/3-install-issue.yml similarity index 92% rename from .github/ISSUE_TEMPLATE/2-install-issue.yml rename to .github/ISSUE_TEMPLATE/3-install-issue.yml index 99eb13e5b075..7e85d2458b44 100644 --- a/.github/ISSUE_TEMPLATE/2-install-issue.yml +++ b/.github/ISSUE_TEMPLATE/3-install-issue.yml @@ -5,7 +5,7 @@ body: - type: markdown attributes: value: | - Have a question? 👉 [Start a new discussion](https://github.com/cypress-io/cypress/discussions) or [ask in chat](https://on.cypress.io/discord). + Have a question? 👉 [Ask in chat](https://on.cypress.io/discord) or [start a new discussion](https://github.com/cypress-io/cypress/discussions). If you're behind a corporate proxy, make sure to [configure it properly](https://on.cypress.io/proxy-configuration) before install. - type: textarea @@ -81,4 +81,4 @@ body: id: other attributes: label: Other - placeholder: Any other details? \ No newline at end of file + placeholder: Any other details? diff --git a/.github/ISSUE_TEMPLATE/3-feature.yml b/.github/ISSUE_TEMPLATE/4-feature.yml similarity index 79% rename from .github/ISSUE_TEMPLATE/3-feature.yml rename to .github/ISSUE_TEMPLATE/4-feature.yml index 48d7a3667019..a6fe86858fce 100644 --- a/.github/ISSUE_TEMPLATE/3-feature.yml +++ b/.github/ISSUE_TEMPLATE/4-feature.yml @@ -4,7 +4,7 @@ body: - type: markdown attributes: value: | - Have a question? 👉 [Start a new discussion](https://github.com/cypress-io/cypress/discussions) or [ask in chat](https://on.cypress.io/discord). + Have a question? 👉 [Ask in chat](https://on.cypress.io/discord) or [start a new discussion](https://github.com/cypress-io/cypress/discussions). - type: textarea id: feature attributes: @@ -23,4 +23,4 @@ body: id: other attributes: label: Other - placeholder: Any other details? \ No newline at end of file + placeholder: Any other details? diff --git a/.github/ISSUE_TEMPLATE/4-flaky-test.yml b/.github/ISSUE_TEMPLATE/5-flaky-test.yml similarity index 89% rename from .github/ISSUE_TEMPLATE/4-flaky-test.yml rename to .github/ISSUE_TEMPLATE/5-flaky-test.yml index cb30750bcb98..da406ba81068 100644 --- a/.github/ISSUE_TEMPLATE/4-flaky-test.yml +++ b/.github/ISSUE_TEMPLATE/5-flaky-test.yml @@ -6,7 +6,7 @@ body: - type: markdown attributes: value: | - Have a question? 👉 [Start a new discussion](https://github.com/cypress-io/cypress/discussions) or [ask in chat](https://on.cypress.io/discord). + Have a question? 👉 [Ask in chat](https://on.cypress.io/discord) or [start a new discussion](https://github.com/cypress-io/cypress/discussions). - type: textarea id: dashboard attributes: