Adding a new GitHub Refresh app integration¶
Adding the GitHub refresh app integration to a new environment requires configuring things in GitHub and Phalanx.
Create a new GitHub app¶
Click the
New GitHub App
button in the lsst-sqre org Developer Settings apps page.Name it
mobu refresh (env URL or id if the URL is too long)
.Make sure the Active checkbox is checked in the Webhook section.
Enter
https://env URL/mobu/github/refresh/webhook
in the Webhook URL input.Generate a strong password to use as the webhook secret.
Store this in the
SQuaRE
vault in theLSST IT
1Password account in anServer
item namedmobu (env URL)
in apassword
field calledgithub-refresh-app-webhook-secret
.Get this into the Phalanx secret store for that env under the key:
github-refresh-app-webhook-secret
(this process is different for different envs).Enter this secret in the Webhook secret (optional) box in the GitHub App config.
Select Contents access category in the Repository Permissions section.
in the dropdown of theCheck the Push checkbox in the Subscribe to events section.
Select the Any account radio button in the Where can this GitHub App be installed? section.
Click the Create GitHub App button.
Install the app for a repo¶
Go to new app’s homepage (something like apps/mobu-refresh-usdfdev).
Click the Install button.
Select the Only select repositories radio button.
Select the repo in the dropdown.
Click Install.
Add Phalanx configuration¶
In applications/mobu/values-env.yaml
, add a config.githubRefreshApp
value:
config:
githubRefreshApp:
acceptedGithubOrgs:
- lsst-sqre
All of these items are required.
accepted_github_orgs
A list of GitHub organizations from which this instance of Mobu will accept webhook requests. Webhook requests from any orgs not in this list will get a
403
response.