Skip to content

add pre-commit.ci badge and doc support #4061

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 12, 2021
Merged

add pre-commit.ci badge and doc support #4061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7bebf49
add pre-commit.ci badge and doc support
bjlittle Mar 12, 2021
7d6feb3
review actions
bjlittle Mar 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@
<a href="https://scitools-iris.readthedocs.io/en/latest/?badge=latest">
<img src="https://readthedocs.org/projects/scitools-iris/badge/?version=latest"
alt="Documentation Status" /></a>
<a href="https://results.pre-commit.ci/latest/github/SciTools/iris/master">
<img src="https://results.pre-commit.ci/badge/github/SciTools/iris/master.svg"
alt="pre-commit.ci status" /></a>
<a href="https://anaconda.org/conda-forge/iris">
<img src="https://img.shields.io/conda/dn/conda-forge/iris.svg"
alt="conda-forge downloads" /></a>
Expand Down
1 change: 1 addition & 0 deletions docs/src/common_links.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
.. _napolean: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/sphinxcontrib.napoleon.html
.. _nox: https://nox.thea.codes/en/stable/
.. _New Issue: https://github.com/scitools/iris/issues/new/choose
.. _pre-commit: https://pre-commit.com/
.. _pull request: https://github.com/SciTools/iris/pulls
.. _pull requests: https://github.com/SciTools/iris/pulls
.. _Read the Docs: https://scitools-iris.readthedocs.io/en/latest/
Expand Down
47 changes: 31 additions & 16 deletions docs/src/developers_guide/contributing_ci_tests.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,12 @@ Continuous Integration (CI) Testing
===================================

The `Iris`_ GitHub repository is configured to run checks against all its
branches automatically whenever a pull request is created, updated or merged.
branches automatically whenever a pull-request is created, updated or merged.
The checks performed are:

* :ref:`testing_cla`
* :ref:`testing_cirrus`


.. _testing_cla:

SciTools CLA Checker
********************

A bot which checks that the GitHub author of the pull request has signed the
**SciTools Contributor's License Agreement (CLA)**. For more information on
this please see https://scitools.org.uk/organisation.html#governance.
* :ref:`testing_cla`
* :ref:`pre_commit_ci`


.. _testing_cirrus:
Expand All @@ -44,7 +35,7 @@ refer to the `Cirrus-CI Documentation`_. The tasks performed during CI include:
* checking all URL references within the code base and documentation are valid

The above `cirrus-ci`_ tasks are run automatically against all `Iris`_ branches
on GitHub whenever a pull request is submitted, updated or merged. See the
on GitHub whenever a pull-request is submitted, updated or merged. See the
`Cirrus-CI Dashboard`_ for details of recent past and active Iris jobs.

.. _skipping Cirrus-CI tasks:
Expand Down Expand Up @@ -79,17 +70,41 @@ e.g., to skip the linting task, the following are all equivalent::


GitHub Checklist
****************
----------------

An example snapshot from a successful GitHub pull request shows all tests
An example snapshot from a successful GitHub pull-request shows all tests
passing:

.. image:: ci_checks.png

If any CI tasks fail, then the pull request is unlikely to be merged to the
If any CI tasks fail, then the pull-request is unlikely to be merged to the
Iris target branch by a core developer.


.. _testing_cla:

SciTools CLA Checker
********************

A bot which checks that the GitHub author of the pull-request has signed the
**SciTools Contributor's License Agreement (CLA)**. For more information on
this please see https://scitools.org.uk/organisation.html#governance.


.. _pre_commit_ci:

pre-commit CI
*************

A CI service for the `pre-commit`_ framework that checks and auto fixes all
pull-requests given the `Iris`_ GitHub repository `.pre-commit-config.yaml`_.

See the `pre-commit.ci dashboard`_ for details of recent past and active Iris jobs.



.. _Cirrus-CI Dashboard: https://cirrus-ci.com/github/SciTools/iris
.. _Cirrus-CI Documentation: https://cirrus-ci.org/guide/writing-tasks/
.. _.pre-commit-config.yaml: https://github.com/SciTools/iris/blob/master/.pre-commit-config.yaml
.. _pre-commit.ci dashboard: https://results.pre-commit.ci/repo/github/5312648

5 changes: 5 additions & 0 deletions docs/src/whatsnew/latest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,9 @@ This document explains the changes made to Iris for this release
#. `@bjlittle`_ added post-release instructions on how to :ref:`update_pypi`
with `scitools-iris`_. (:pull:`4038`)

#. `@bjlittle`_ added the |pre-commit.ci|_ badge to the `README.md`_.
See :ref:`pre_commit_ci` for further details. (:pull:`4061`)


💼 Internal
===========
Expand Down Expand Up @@ -159,6 +162,8 @@ This document explains the changes made to Iris for this release
.. _GitHub: https://github.com/SciTools/iris/issues/new/choose
.. _Met Office: https://www.metoffice.gov.uk/
.. _numpy: https://numpy.org/doc/stable/release/1.20.0-notes.html
.. |pre-commit.ci| image:: https://results.pre-commit.ci/badge/github/SciTools/iris/master.svg
.. _pre-commit.ci: https://results.pre-commit.ci/latest/github/SciTools/iris/master
.. |PyPI| image:: https://img.shields.io/pypi/v/scitools-iris?color=orange&label=pypi%7Cscitools-iris
.. _PyPI: https://pypi.org/project/scitools-iris/
.. _Python 3.8: https://www.python.org/downloads/release/python-380/
Expand Down