From 447d994fe28ea100fed54d319fd1da1d6d19354a Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Tue, 15 Feb 2022 15:33:11 +0100 Subject: [PATCH 1/5] Add inline comments about pytest-xdist --- Makefile | 4 ++-- requirements-dev.txt | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 4d6688cc..13673150 100644 --- a/Makefile +++ b/Makefile @@ -207,7 +207,7 @@ run-sudo-shell/%: ## run a bash in interactive mode as root in a stack test/%: ## run tests against a stack (only common tests or common tests + specific tests) @echo "::group::test/$(OWNER)/$(notdir $@)" - @if [ ! -d "$(notdir $@)/test" ]; then TEST_IMAGE="$(OWNER)/$(notdir $@)" pytest -n auto -m "not info" test; \ - else TEST_IMAGE="$(OWNER)/$(notdir $@)" pytest -n auto -m "not info" test $(notdir $@)/test; fi + @if [ ! -d "$(notdir $@)/test" ]; then TEST_IMAGE="$(OWNER)/$(notdir $@)" pytest --numprocesses=auto -m "not info" test; \ + else TEST_IMAGE="$(OWNER)/$(notdir $@)" pytest --numprocesses=auto -m "not info" test $(notdir $@)/test; fi @echo "::endgroup::" test-all: $(foreach I, $(ALL_IMAGES), test/$(I)) ## test all stacks diff --git a/requirements-dev.txt b/requirements-dev.txt index 193cad0c..7c59c0fc 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -3,6 +3,8 @@ packaging plumbum pre-commit pytest +# pytest-xdist is a plugin that provides the --numprocesses flag, allowing us to +# run pytest tests in parallel. pytest-xdist requests tabulate From 2ebea98ec2ddecd733aff6bc4ab9edc8bb6ac2e2 Mon Sep 17 00:00:00 2001 From: Tania Allard Date: Tue, 15 Feb 2022 19:45:44 +0000 Subject: [PATCH 2/5] :wrench: ENH: Replace templates for new forms and config --- .github/ISSUE_TEMPLATE/bug_report.yml | 104 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 14 +++ .github/ISSUE_TEMPLATE/feature_request.md | 26 ------ .github/ISSUE_TEMPLATE/feature_request.yml | 59 ++++++++++++ 4 files changed, 177 insertions(+), 26 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..5c4b6bca --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,104 @@ +name: Bug report +description: Create a report to help us improve +title: "BUG - " +labels: ["type:Bug"] + +body: + - type: markdown + attributes: + value: | + Hi! Thanks for using the Jupyter Docker Stacks and taking some time to contribute to this project. + + We'd appreciate it if you could check out the [Troubleshooting common problems](https://jupyter-docker-stacks.readthedocs.io/en/latest/using/troubleshooting.html) section in the documentation. + + Please answer the following sections to help us troubleshoot the problem. + + - type: dropdown + id: docker_images + attributes: + label: What docker image are you using? + description: Select as many images as applicable + multiple: true + options: + - all-spark-notebook + - base-notebook + - datascience-notebook + - minimal-notebook + - pyspark-notebook + - r-notebook + - scipy-notebook + - tensorflow-notebook + validations: + required: true + + - type: input + attributes: + label: OS system you are using + validations: + required: true + + - type: textarea + attributes: + label: What Docker command are you running? + description: | + What complete docker command do you run to launch the container (omitting sensitive values)? + placeholder: | + Example: + `docker run -it --rm -p 8888:8888 jupyter/all-spark-notebook` + validations: + required: true + + - type: textarea + attributes: + label: How to Reproduce + description: Please provide steps to reproduce this bug (once the container is running). + placeholder: | + Example: + 1. Visit <http://localhost:8888> + 2. Start an R notebook + 3. ... + validations: + required: true + + - type: textarea + attributes: + label: command_output + render: sh-session + description: | + Provide the output of the steps above, including the commands + themselves and Docker's output/traceback etc. If you're familiar with + Markdown, this block will have triple backticks added automatically + around it -- you don't have to add them. + + If you want to present output from multiple commands, please present + that as a shell session (commands you run get prefixed with `$ `). + Please also ensure that the "How to reproduce" section contains matching + instructions for reproducing this. + + - type: textarea + attributes: + label: Expected behavior + description: | + A clear and concise description of what you expected to happen. + placeholder: | + Example: ggplot output appears in my notebook. + + - type: textarea + attributes: + label: Actual behavior + description: | + A clear and concise description of what the bug is. + placeholder: | + Example: No output is visible in the notebook and the notebook server log contains messages about ... + validations: + required: true + + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..6f8ec16f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: "💬 Jupyter community Discourse" + url: https://discourse.jupyter.org/ + about: Interact with the rest of the Jupyter community + - name: "📖 Jupyter Docker Stacks documentation" + url: https://jupyter-docker-stacks.readthedocs.io/en/latest/index.html + about: Go to the project's documentation + - name: "🔍 Troubleshooting common problems" + url: https://jupyter-docker-stacks.readthedocs.io/en/latest/using/troubleshooting.html + about: Documentation section on troubleshooting commonly encountered errors + - name: "(maintainers only) Blank issue" + url: https://github.com/jupyter/docker-stacks/issues/new + about: For maintainers only diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 7394fcd6..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "" -labels: "type:Enhancement" -assignees: "" ---- - -Hi! Thanks for using the Jupyter Docker Stacks. - -Please see the [Suggesting a new feature](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/features.html#suggesting-a-new-feature) section in the documentation for our preferred processes. - -**What docker images this feature is applicable to?** - -Example: `jupyter/scipy-notebook` - -**What changes do you propose?** - -Example: Add a package [altair](https://altair-viz.github.io). - -**How does this change will affect users?** - -Example: Altair is a declarative statistical visualization library for Python, based on Vega and Vega-Lite, and the source is available on GitHub. -With Altair, you can spend more time understanding your data and its meaning. -Altair’s API is simple, friendly and consistent and built on top of the powerful Vega-Lite visualization grammar. -This elegant simplicity produces beautiful and effective visualizations with a minimal amount of code. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..4537afe1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,59 @@ +name: Feature request +description: Suggest a new feature for this project +labels: ["type:Enhancement"] +title: "[ENH]: <title>" + +body: + - type: markdown + attributes: + value: >- + Hi! Thanks for using the Jupyter Docker Stacks and taking some time to contribute to this project. + + We'd appreciate it if you could check out the [Suggesting a new feature](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/features.html#suggesting-a-new-feature) section in the documentation for our preferred processes before submitting a feature request. + + - type: dropdown + id: docker_images + attributes: + label: What docker images is this feature applicable to? + description: Select as many images as applicable + multiple: true + options: + - all-spark-notebook + - base-notebook + - datascience-notebook + - minimal-notebook + - pyspark-notebook + - r-notebook + - scipy-notebook + - tensorflow-notebook + validations: + required: true + + - type: textarea + attributes: + label: What changes are you proposing? + description: >- + Example: + - Add the [altair](https://altair-viz.github.io) package to the image. + validations: + required: true + + - type: textarea + attributes: + label: How does this affect the user? + description: >- + Example: + - Altair is a declarative statistical visualization library for Python, based on Vega and Vega-Lite, and the source is available on GitHub. + - With Altair, you can spend more time understanding your data and its meaning. + - Altair’s API is simple, friendly and consistent and built on top of the powerful Vega-Lite visualization grammar. + - This elegant simplicity produces beautiful and effective visualizations with a minimal amount of code. + validations: + required: true + + - type: textarea + attributes: + label: Anything else? + description: >- + Links? References? Anything that will give us more context about the feature you are proposing. + validations: + required: false From c498272d1ff38c8ef7dfde3c587ce044830cd891 Mon Sep 17 00:00:00 2001 From: Tania Allard <taniar.allard@gmail.com> Date: Wed, 16 Feb 2022 11:51:16 +0000 Subject: [PATCH 3/5] :wrench: Add option for community stack --- .github/ISSUE_TEMPLATE/bug_report.yml | 8 ++++++-- .github/ISSUE_TEMPLATE/feature_request.yml | 14 ++++++++------ 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 5c4b6bca..8fc515db 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -9,7 +9,8 @@ body: value: | Hi! Thanks for using the Jupyter Docker Stacks and taking some time to contribute to this project. - We'd appreciate it if you could check out the [Troubleshooting common problems](https://jupyter-docker-stacks.readthedocs.io/en/latest/using/troubleshooting.html) section in the documentation. + We'd appreciate it if you could check out the [Troubleshooting common problems](https://jupyter-docker-stacks.readthedocs.io/en/latest/using/troubleshooting.html) section in the documentation, + as well as [existing issues](https://github.com/jupyter/docker-stacks/issues) prior to submitting an issue to avoid duplication. Please answer the following sections to help us troubleshoot the problem. @@ -34,6 +35,9 @@ body: - type: input attributes: label: OS system you are using + placeholder: | + Example: + Linux - Ubuntu validations: required: true @@ -63,7 +67,7 @@ body: - type: textarea attributes: label: command_output - render: sh-session + render: bash session description: | Provide the output of the steps above, including the commands themselves and Docker's output/traceback etc. If you're familiar with diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 4537afe1..c2764279 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -6,10 +6,11 @@ title: "[ENH]: <title>" body: - type: markdown attributes: - value: >- + value: | Hi! Thanks for using the Jupyter Docker Stacks and taking some time to contribute to this project. - We'd appreciate it if you could check out the [Suggesting a new feature](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/features.html#suggesting-a-new-feature) section in the documentation for our preferred processes before submitting a feature request. + We'd appreciate it if you could check out the [Suggesting a new feature](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/features.html#suggesting-a-new-feature) + section in the documentation for our preferred processes before submitting a feature request. - type: dropdown id: docker_images @@ -26,13 +27,14 @@ body: - r-notebook - scipy-notebook - tensorflow-notebook + - new community stack validations: required: true - type: textarea attributes: label: What changes are you proposing? - description: >- + description: | Example: - Add the [altair](https://altair-viz.github.io) package to the image. validations: @@ -41,11 +43,11 @@ body: - type: textarea attributes: label: How does this affect the user? - description: >- + description: | Example: - Altair is a declarative statistical visualization library for Python, based on Vega and Vega-Lite, and the source is available on GitHub. - With Altair, you can spend more time understanding your data and its meaning. - - Altair’s API is simple, friendly and consistent and built on top of the powerful Vega-Lite visualization grammar. + - Altair's API is simple, friendly and consistent and built on top of the powerful Vega-Lite visualization grammar. - This elegant simplicity produces beautiful and effective visualizations with a minimal amount of code. validations: required: true @@ -53,7 +55,7 @@ body: - type: textarea attributes: label: Anything else? - description: >- + description: | Links? References? Anything that will give us more context about the feature you are proposing. validations: required: false From 66cdbf6cf2e42151455e03ae97cc933966a48194 Mon Sep 17 00:00:00 2001 From: Tania Allard <taniar.allard@gmail.com> Date: Thu, 17 Feb 2022 09:25:30 +0000 Subject: [PATCH 4/5] Update .github/ISSUE_TEMPLATE/feature_request.yml Co-authored-by: Ayaz Salikhov <mathbunnyru@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index c2764279..2d64a159 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,7 +1,7 @@ name: Feature request description: Suggest a new feature for this project -labels: ["type:Enhancement"] title: "[ENH]: <title>" +labels: ["type:Enhancement"] body: - type: markdown From 3fe9ddddff30b05d3c84a515766c00c0888460ef Mon Sep 17 00:00:00 2001 From: Tania Allard <taniar.allard@gmail.com> Date: Thu, 17 Feb 2022 09:27:51 +0000 Subject: [PATCH 5/5] Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Ayaz Salikhov <mathbunnyru@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 8fc515db..823f3570 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -34,10 +34,10 @@ body: - type: input attributes: - label: OS system you are using + label: OS system and architecture running docker image placeholder: | Example: - Linux - Ubuntu + Ubuntu/aarch64 validations: required: true