opendev/system-config
Code Issues Proposed changes

Update references to OpenDev Zuul

Browse Source 
The GitHub app has been updated to be called OpenDev Zuul. Update
the docs accordingly.

Change-Id: I384f84d2d291e82c2062b116c77f1b062a009907
This commit is contained in:
Monty Taylor 2019-05-22 10:59:55 -05:00
parent 2c78db0146
commit 40e3cf3c5e
2 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/source/github.rst
View File

@ -31,7 +31,7 @@ There are currently three different forms of interaction with GitHub.
* Gerrit Replication * Gerrit Replication
* Pull Request Closer * Pull Request Closer
* OpenStack Zuul App * OpenDev Zuul App
Gerrit Replication Gerrit Replication
------------------ ------------------
@ -52,18 +52,18 @@ be found in the :ref:`jeepyb` document at :ref:`closing_pull_requests`.
.. _openstack_zuul_app: .. _openstack_zuul_app:
OpenStack Zuul App OpenDev Zuul App
------------------ ----------------
Zuul v3 is integrated with GitHub by way of a `GitHub App`_. This is done to Zuul v3 is integrated with GitHub by way of a `GitHub App`_. This is done to
enable OpenStack to test integration with external projects that use GitHub enable OpenStack to test integration with external projects that use GitHub
for development. Information on configuring projects to use the OpenStack Zuul for development. Information on configuring projects to use the OpenDev Zuul
App can be found in the :ref:`zuul` page at :ref:`zuul_github_projects`. App can be found in the :ref:`zuul` page at :ref:`zuul_github_projects`.
The OpenStack Zuul App is managed `OpenStack Zuul Settings Page`_ which is The OpenDev Zuul App is managed `OpenDev Zuul Settings Page`_ which is
available to admins of the `openstack-infra Organization`_. available to admins of the `opendevorg Organization`_.
The OpenStack Zuul App has an ID, a Private key, a Webhook secret and a set of The OpenDev Zuul App has an ID, a Private key, a Webhook secret and a set of
OAuth Credentials which are all stored in hiera. OAuth Credentials which are all stored in hiera.
The ID is a numerical identifier found on the App settings page labeled **ID**. The ID is a numerical identifier found on the App settings page labeled **ID**.
@ -85,8 +85,8 @@ did come from GitHub. The "Webhook Secret" is placed into the ``webhook_token``
field in the ``github`` entry in ``zuul_connection_secrets`` for the field in the ``github`` entry in ``zuul_connection_secrets`` for the
``zuul-scheduler`` group. ``zuul-scheduler`` group.
The OAuth credentials for the OpenStack Zuul App are currently unused. The OAuth credentials for the OpenDev Zuul App are currently unused.
.. _GitHub App: https://developer.github.com/apps/ .. _GitHub App: https://developer.github.com/apps/
.. _OpenStack Zuul Settings Page: https://github.com/organizations/openstack-infra/settings/apps/openstack-zuul. .. _OpenDev Zuul Settings Page: https://github.com/organizations/opendevorg/settings/apps/opendev-zuul.
.. _openstack-infra Organization: https://github.com/organizations/openstack-infra/settings/profile .. _opendevorg Organization: https://github.com/organizations/opendevorg/settings/profile

8
doc/source/zuulv3.rst
View File

@ -210,19 +210,19 @@ OpenStack does not use GitHub for development purposes, but there are some
non-OpenStack projects in the broader ecosystem that we care about who do. non-OpenStack projects in the broader ecosystem that we care about who do.
When we are interested in setting up jobs in Zuul to test the interaction When we are interested in setting up jobs in Zuul to test the interaction
between OpenStack projects and those ecosystem projects, we can add the between OpenStack projects and those ecosystem projects, we can add the
OpenStack Zuul GitHub app to those projects, then configure them in Zuul. OpenDev Zuul GitHub app to those projects, then configure them in Zuul.
In order to add the GitHub app to a project, an admin on that project should In order to add the GitHub app to a project, an admin on that project should
navigate to the `OpenStack Zuul`_ app in the GitHub UI. From there they can navigate to the `OpenDev Zuul`_ app in the GitHub UI. From there they can
click "Install", then choose the project or organization they want to install click "Install", then choose the project or organization they want to install
the App on. the App on.
The repository then needs to be added to the `zuul/main.yaml` file before Zuul The repository then needs to be added to the `zuul/main.yaml` file before Zuul
can be configured to actually run jobs on it. can be configured to actually run jobs on it.
Information about the configuration of the OpenStack Zuul App itself can be Information about the configuration of the OpenDev Zuul App itself can be
found on the :ref:`github` page at :ref:`openstack_zuul_app`. found on the :ref:`github` page at :ref:`openstack_zuul_app`.
.. _OpenStack Zuul: https://github.com/apps/openstack-zuul .. _OpenDev Zuul: https://github.com/apps/opendev-zuul
.. _Zuul Reference Manual: https://docs.openstack.org/infra/zuul .. _Zuul Reference Manual: https://docs.openstack.org/infra/zuul
.. _Zuul Status Page: http://zuul.openstack.org .. _Zuul Status Page: http://zuul.openstack.org