Skip to content

update github app docs #4844

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
trexfeathers merged 1 commit into from
Jul 1, 2022
Merged

update github app docs #4844

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 10 additions & 1 deletion docs/src/developers_guide/github_app.rst
View file
Open in desktop
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