GitHub¶
GitHub is a code-hosting platform that, while not used for OpenStack development, is nonetheless frequently enough used by non-OpenStack projects that OpenStack has tooling interactions with it.
At a Glance¶
- Hosts
review.opendev.org
- Puppet
- Projects
- Chat
#opendev on freenode
Overview¶
There are currently three different forms of interaction with GitHub.
Gerrit Replication
Pull Request Closer
OpenDev Zuul App
Gerrit Replication¶
Each project in gerrit is replicated on merge to a corresponding repository in GitHub. More information on this can be found in the Gerrit document at GitHub Integration.
Pull Request Closer¶
A cronjob is run that looks for Pull Requests that have been erroneously submitted and closes them with a helpful message pointing people to the documentation on Contributing to OpenStack. More information on this can be found in the Jeepyb document at Closing Github Pull Requests.
OpenDev Zuul App¶
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 for development. Information on configuring projects to use the OpenDev Zuul App can be found in the Zuul page at GitHub Projects.
The OpenDev Zuul App is managed OpenDev Zuul Settings Page which is available to admins of the opendevorg Organization.
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.
The ID is a numerical identifier found on the App settings page labeled ID.
The ID is placed into the app_id
field in the github
entry in zuul_connection_secrets
for the zuul-scheduler
group.
The Private key can only be retrieved when it is generated, so in the case it
is lost a new one must be generated and the resulting value put into hiera.
The Private key content is stored as zuul_github_app_key
in private hiera
and is written to /etc/zuul/github.key
. That path is placed into
app_key
field in the github
entry in zuul_connections
for the
zuul-scheduler
group.
GitHub sends JSON payloads via HTTP POST to the URL configured in the Webhook
URL setting. The current value of this setting for Zuul v3 is:
https://zuul.openstack.org/connection/github/payload. It includes the
configured “Webhook Secret” so that Zuul can verify that the payload actually
did come from GitHub. The “Webhook Secret” is placed into the webhook_token
field in the github
entry in zuul_connection_secrets
for the
zuul-scheduler
group.
The OAuth credentials for the OpenDev Zuul App are currently unused.