Skip to content

Commit

Permalink
Merge branch 'numpydoc-pre-commit' of github.com:tkknight/iris into n…
Browse files Browse the repository at this point in the history
…umpydoc-pre-commit

* 'numpydoc-pre-commit' of github.com:tkknight/iris:
  Update documentation for the new v5 CLA. (SciTools#5664)
  Add an auto-labeller to always benchmark lock file changes (SciTools#5763)
  • Loading branch information
tkknight committed Feb 23, 2024
2 parents 78f087c + 3a2b9a4 commit 97af3e6
Show file tree
Hide file tree
Showing 7 changed files with 49 additions and 19 deletions.
6 changes: 6 additions & 0 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Make sure any dependency changes are benchmarked (only changes to the locks
# make a material difference - changes to the Conda YAML files are not
# benchmarked).
benchmark_this:
- changed-files:
- any-glob-to-any-file: 'requirements/locks/*.lock'
15 changes: 15 additions & 0 deletions .github/workflows/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Reference
# - https://github.com/actions/labeler

name: "Pull Request Labeler"
on:
- pull_request_target

jobs:
labeler:
permissions:
contents: read
pull-requests: write
runs-on: ubuntu-latest
steps:
- uses: actions/labeler@v5
5 changes: 3 additions & 2 deletions docs/src/common_links.inc
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
.. _cirrus-ci: https://cirrus-ci.com/github/SciTools/iris
.. _codespell: https://github.com/codespell-project/codespell
.. _conda: https://docs.conda.io/en/latest/
.. _contributor: https://github.com/SciTools/scitools.org.uk/blob/master/contributors.json
.. _core developers: https://github.com/SciTools/scitools.org.uk/blob/master/contributors.json
.. _contributor: https://github.com/SciTools/iris/graphs/contributors
.. _core developers: https://github.com/orgs/SciTools/teams/iris-devs/members
.. _generating ssh keys for GitHub: https://docs.github.com/en/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account
.. _GitHub Actions: https://docs.github.com/en/actions
.. _GitHub Help Documentation: https://docs.github.com/en/github
Expand Down Expand Up @@ -45,6 +45,7 @@
.. _python-stratify: https://github.com/SciTools/python-stratify
.. _iris-esmf-regrid: https://github.com/SciTools-incubator/iris-esmf-regrid
.. _netCDF4: https://github.com/Unidata/netcdf4-python
.. _SciTools Contributor's License Agreement (CLA): https://cla-assistant.io/SciTools/
.. comment
Expand Down
11 changes: 6 additions & 5 deletions docs/src/developers_guide/contributing_ci_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,11 @@ Iris target branch by a core developer.

.. _testing_cla:

SciTools CLA Checker
********************
`CLA Assistant`_
****************

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.
A bot which checks that the GitHub authors of the pull-request have signed the
|SciTools Contributor's License Agreement (CLA)|_.


.. _pre_commit_ci:
Expand Down Expand Up @@ -147,4 +146,6 @@ For more information on how to use `ruff`_ please see the `ruff documentation`_.

.. _.pre-commit-config.yaml: https://github.com/SciTools/iris/blob/main/.pre-commit-config.yaml
.. _pre-commit.ci dashboard: https://results.pre-commit.ci/repo/github/5312648
.. _CLA Assistant: https://github.com/cla-assistant/cla-assistant
.. |SciTools Contributor's License Agreement (CLA)| replace:: **SciTools Contributor's License Agreement (CLA)**
.. _ruff documentation: https://docs.astral.sh/ruff/tutorial/
7 changes: 4 additions & 3 deletions docs/src/developers_guide/contributing_documentation_easy.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@

.. include:: ../common_links.inc

.. _contributing.documentation_easy:

Contributing to the Documentation (the easy way)
Expand All @@ -15,11 +17,10 @@ the improvement yourself)!

First Time Only Steps
^^^^^^^^^^^^^^^^^^^^^

1. Create a `GitHub <https://github.com/>`_ account.

2. Complete the Scitools Contributor License Agreement (`link to Google Form
<https://docs.google.com/forms/d/e/1FAIpQLSfd0tdE-DcJOXh8ej_7T93IizwJFYBFyRWYQOi2A8QRaKwykA/viewform>`_).
2. Complete the `SciTools Contributor's License Agreement (CLA)`_.
This is a one-off requirement for anyone who wishes to contribute to a
Scitools repository - including the documentation.

Expand Down
16 changes: 8 additions & 8 deletions docs/src/developers_guide/contributing_getting_involved.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,22 +22,22 @@ Alternatively, **join the conversation** in Iris `GitHub Discussions`_, when
you would like the opinions of the Iris community.

A `pull request`_ may also be created by anyone who has become a
**contributor** to Iris_. Permissions to merge pull requests to the
``main`` branch are only given to **core developers** of Iris_, this is
to ensure a measure of control.
|contributor|_ to Iris_. Permissions to merge pull requests to the
``main`` branch are only given to |core developers|_ of Iris_, this is
to ensure a measure of control. All authors on a pull request will
automatically be asked to sign the
`SciTools Contributor's License Agreement (CLA)`_, if they have not already
done so.

To get started we suggest reading recent `issues`_, `GitHub Discussions`_ and
`pull requests`_ for Iris.

If you are new to using GitHub we recommend reading the
`GitHub getting started`_

.. note:: For more information on becoming a contributor_ including a link to
the Contributors Licence Agreement (CLA) see the
`Governance <https://scitools.org.uk/organisation.html#governance>`_
section of the `SciTools`_ ogranization web site.

.. _GitHub getting started: https://docs.github.com/en/github/getting-started-with-github
.. |contributor| replace:: **contributor**
.. |core developers| replace:: **core developers**


.. toctree::
Expand Down
8 changes: 7 additions & 1 deletion docs/src/whatsnew/latest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,11 @@ This document explains the changes made to Iris for this release
💼 Internal
===========

#. N/A
#. `@trexfeathers`_ used the `Pull Request Labeler Github action`_ to add the
``benchmark_this`` label (:ref:`more info <on_demand_pr_benchmark>`) to
pull requests that modify ``requirements/locks/*.lock`` files - ensuring
that we know whether dependency changes will affect performance.
(:pull:`5763`)


.. comment
Expand All @@ -84,3 +88,5 @@ This document explains the changes made to Iris for this release
.. comment
Whatsnew resources in alphabetical order:
.. _Pull Request Labeler GitHub action: https://github.com/actions/labeler

0 comments on commit 97af3e6

Please sign in to comment.