From 412e184e4bde260c2875a72c248aa48e6b79908a Mon Sep 17 00:00:00 2001 From: Gurudatta Shanbhag Date: Sun, 15 Oct 2023 00:36:47 +0530 Subject: [PATCH 1/4] fixes 26998 --- doc/devel/coding_guide.rst | 50 +-------------------------- doc/devel/development_workflow.rst | 54 ++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+), 49 deletions(-) diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst index 8e2a0aa7df4b..567891b9a1fd 100644 --- a/doc/devel/coding_guide.rst +++ b/doc/devel/coding_guide.rst @@ -339,55 +339,7 @@ Merging Automated tests --------------- - -Whenever a pull request is created or updated, various automated test tools -will run on all supported platforms and versions of Python. - -* Make sure the Linting, GitHub Actions, AppVeyor, CircleCI, and Azure - pipelines are passing before merging (All checks are listed at the bottom of - the GitHub page of your pull request). Here are some tips for finding the - cause of the test failure: - - - If *Linting* fails, you have a code style issue, which will be listed - as annotations on the pull request's diff. - - If *Mypy* or *Stubtest* fails, you have inconsistency in type hints, which - will be listed as annotations in the diff. - - If a GitHub Actions or AppVeyor run fails, search the log for ``FAILURES``. - The subsequent section will contain information on the failed tests. - - If CircleCI fails, likely you have some reStructuredText style issue in - the docs. Search the CircleCI log for ``WARNING``. - - If Azure pipelines fail with an image comparison error, you can find the - images as *artifacts* of the Azure job: - - - Click *Details* on the check on the GitHub PR page. - - Click *View more details on Azure Pipelines* to go to Azure. - - On the overview page *artifacts* are listed in the section *Related*. - - -* Codecov and CodeQL are currently for information only. Their failure is not - necessarily a blocker. - -* tox_ is not used in the automated testing. It is supported for testing - locally. - - .. _tox: https://tox.readthedocs.io/ - -* If you know only a subset of CIs need to be run, this can be controlled on - individual commits by including the following substrings in commit messages: - - - ``[ci doc]``: restrict the CI to documentation checks. For when you only - changed documentation (this skip is automatic if the changes are only under - ``doc/`` or ``galleries/``). - - ``[skip circle]``: skip the documentation build check. For when you didn't - change documentation. - - Unit tests can be turned off for individual platforms with - - - ``[skip actions]``: GitHub Actions - - ``[skip appveyor]`` (must be in the first line of the commit): AppVeyor - - ``[skip azp]``: Azure Pipelines - - - ``[skip ci]``: skip all CIs. Use this only if you know your changes do not - need to be tested at all, which is very rare. +:ref:`automated-tests` .. _pr-squashing: diff --git a/doc/devel/development_workflow.rst b/doc/devel/development_workflow.rst index c03dab47c759..addc4315b94a 100644 --- a/doc/devel/development_workflow.rst +++ b/doc/devel/development_workflow.rst @@ -426,3 +426,57 @@ thought it was. Be judicious with force-pushing. It is effectively re-writing published history, and if anyone has fetched the old commits, it will have a different view of history which can cause confusion. + +.. _automated-tests: + +Automated tests +--------------- + +Whenever a pull request is created or updated, various automated test tools +will run on all supported platforms and versions of Python. + +* Make sure the Linting, GitHub Actions, AppVeyor, CircleCI, and Azure + pipelines are passing before merging (All checks are listed at the bottom of + the GitHub page of your pull request). Here are some tips for finding the + cause of the test failure: + + - If *Linting* fails, you have a code style issue, which will be listed + as annotations on the pull request's diff. + - If *Mypy* or *Stubtest* fails, you have inconsistency in type hints, which + will be listed as annotations in the diff. + - If a GitHub Actions or AppVeyor run fails, search the log for ``FAILURES``. + The subsequent section will contain information on the failed tests. + - If CircleCI fails, likely you have some reStructuredText style issue in + the docs. Search the CircleCI log for ``WARNING``. + - If Azure pipelines fail with an image comparison error, you can find the + images as *artifacts* of the Azure job: + + - Click *Details* on the check on the GitHub PR page. + - Click *View more details on Azure Pipelines* to go to Azure. + - On the overview page *artifacts* are listed in the section *Related*. + + +* Codecov and CodeQL are currently for information only. Their failure is not + necessarily a blocker. + +* tox_ is not used in the automated testing. It is supported for testing + locally. + + .. _tox: https://tox.readthedocs.io/ + +* If you know only a subset of CIs need to be run, this can be controlled on + individual commits by including the following substrings in commit messages: + + - ``[ci doc]``: restrict the CI to documentation checks. For when you only + changed documentation (this skip is automatic if the changes are only under + ``doc/`` or ``galleries/``). + - ``[skip circle]``: skip the documentation build check. For when you didn't + change documentation. + - Unit tests can be turned off for individual platforms with + + - ``[skip actions]``: GitHub Actions + - ``[skip appveyor]`` (must be in the first line of the commit): AppVeyor + - ``[skip azp]``: Azure Pipelines + + - ``[skip ci]``: skip all CIs. Use this only if you know your changes do not + need to be tested at all, which is very rare. From 57e0f29f1e29b4031be11812b4b79faa04092e36 Mon Sep 17 00:00:00 2001 From: Gurudatta Shanbhag Date: Sun, 15 Oct 2023 08:41:20 +0530 Subject: [PATCH 2/4] Update doc/devel/coding_guide.rst Co-authored-by: hannah --- doc/devel/coding_guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst index 567891b9a1fd..8f6e7ca494da 100644 --- a/doc/devel/coding_guide.rst +++ b/doc/devel/coding_guide.rst @@ -339,7 +339,7 @@ Merging Automated tests --------------- -:ref:`automated-tests` +Before being merged, a PR should pass the :ref:`automated-tests`. If you're unsure why a test is failing, ask on the PR or in our :ref:`chat space `_ .. _pr-squashing: From c8e9008ce7801f37f139909ce765cb945aed0016 Mon Sep 17 00:00:00 2001 From: Gurudatta Shanbhag Date: Sun, 15 Oct 2023 10:02:25 +0530 Subject: [PATCH 3/4] Update doc/devel/coding_guide.rst Co-authored-by: hannah --- doc/devel/coding_guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst index 8f6e7ca494da..87088e8883c1 100644 --- a/doc/devel/coding_guide.rst +++ b/doc/devel/coding_guide.rst @@ -339,7 +339,7 @@ Merging Automated tests --------------- -Before being merged, a PR should pass the :ref:`automated-tests`. If you're unsure why a test is failing, ask on the PR or in our :ref:`chat space `_ +Before being merged, a PR should pass the :ref:`automated-tests`. If you're unsure why a test is failing, ask on the PR or in our `chat space `_ .. _pr-squashing: From ef6e1d4baa754d9f8ff29909b7ed5f730001df50 Mon Sep 17 00:00:00 2001 From: Gurudatta Shanbhag Date: Sun, 15 Oct 2023 12:59:22 +0530 Subject: [PATCH 4/4] Update doc/devel/coding_guide.rst Co-authored-by: hannah --- doc/devel/coding_guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst index 87088e8883c1..49f35e3ad13e 100644 --- a/doc/devel/coding_guide.rst +++ b/doc/devel/coding_guide.rst @@ -339,7 +339,7 @@ Merging Automated tests --------------- -Before being merged, a PR should pass the :ref:`automated-tests`. If you're unsure why a test is failing, ask on the PR or in our `chat space `_ +Before being merged, a PR should pass the :ref:`automated-tests`. If you are unsure why a test is failing, ask on the PR or in our `chat space `_ .. _pr-squashing: