Skip to content

Commit

Permalink
update github app docs (#4844)
Browse files Browse the repository at this point in the history
  • Loading branch information
bjlittle authored Jul 1, 2022
1 parent 44fae03 commit 40e9a9e
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/src/developers_guide/github_app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@ Token GitHub App
This section of the documentation is applicable only to GitHub `SciTools`_
Organisation **owners** and **administrators**.

.. note::

The ``iris-actions`` GitHub App has been rebranded with the more generic
name ``scitools-ci``, as the app can be used for any `SciTools`_ repository,
not just ``iris`` specifically.

All of the following instructions are still applicable.


This section describes how to create, configure, install and use our `SciTools`_
GitHub App for generating tokens for use with *GitHub Actions* (GHA).

Expand Down Expand Up @@ -269,4 +278,4 @@ to generate a token for use with the `create-pull-request`_ GHA:
.. _conda-lock: https://github.com/conda-incubator/conda-lock
.. _create-pull-request: https://github.com/peter-evans/create-pull-request
.. _github-app-token: https://github.com/tibdex/github-app-token
.. _refresh-lockfiles: https://github.com/SciTools/iris/blob/main/.github/workflows/refresh-lockfiles.yml
.. _refresh-lockfiles: https://github.com/SciTools/iris/blob/main/.github/workflows/refresh-lockfiles.yml

0 comments on commit 40e9a9e

Please sign in to comment.