Connect your GitHub organization to your workspace to enable powerful features like GitHub Job Agent, Release Scanner, and Deployment Configuration.
On Github, create a new Github App
https://github.com/organizations/<your-org>/settings/apps/new
Configure the Github App
Field | Value |
---|---|
Github App Name | ctrlplane-{your-instance-name} |
Homepage URL | <your-instance-url> |
Webhook URL | <your-instance-url>/api/github/webhook |
Actions: Read and write
Allows the
creation of workflow runs associated with your deployments.Contents: Read only
Allows
Ctrlplane to detect changes to your *ctrlplane.yaml
configuration files.
Read more about configuration management.Members: Read only
Allows you to
configure github organizations across your workspaces.Push
Subscribe to push events to
sync changes to your deployment configurations.Workflow run
Subscribe to workflow
run events to sync the status of your distpatched workflows. See
Actions Dispatcher for more information.Copy the Client Secret
Generate a new private key
-----BEGIN RSA PRIVATE KEY-----...
).