Setting Up a GitHub App
If GitHub is your VCS provider, you must create a GitHub App and install it on the repositories that Garden Cloud should have access to. The app will be used to authenticate users, import projects, run workflows on GitHub events (e.g. when a pull request is opened), and more.
GitHub App name
You can choose your own app name and description.
Expire user authorization tokens
Request user authorization (OAuth) during installation
The webhook secret is required for Garden Cloud, even though it's marked as optional by GitHub. The value you provide here will also be used during the installation of Garden Cloud. Note that you can always look it up from the GitHub App page later.
Select "Enable SSL verification".
The GitHub App should subscribe to the following events:
- Check Run
- Check Suite
- Issue Comment
- Pull Request
The GitHub App must be installed on all the repositories that Garden Cloud should have access to. This includes repositories that are referenced as remote sources in your Garden projects. Please follow the official instructions for installing the app.
You'll need to have the following values from your GitHub App at hand when installing Garden Cloud:
- App ID and Client ID (see top of the app page)
- A generated Client secret (see top of the app page)
- The user generated webhook secret
- A generated Private key (see bottom of app page)