Links

GitHub Application Setup

You will need to create and register a GitHub App under your personal account or under any organization you have administrative access to.
Learn more about creating GitHub Apps.
Org vs. Personal
Depending on your usage, your entry point for creating a GitHub app will differ:
You'll be asked provide details for the app, here are the required values:
Field
Description
GitHub App name
Can be anything, suggest using colophon + you-org-name as a suffix
Homepage URL
Set to https://colophon.id
User authorization callback URL
The full URL to redirect to after a user authorizes an installation. Use https://your-app-domain + /auth/callback
Webhook URL
Events will POST to this URL. Use the root url of the app https://your-app-domain
Webhook secret (optional)
While optional, this is recommended to ensure your Colophon data is secure from external manipulation

Permissions

Learn more about GitHub Permissions from the official GitHub documentation
Colophon will require access the following permissions to your GitHub account:
Name
Access
Repository contents
Read-only
Repository metadata
Read-only
Organization members
Read-only

Events

Learn more about GitHub Event from the official GitHub documentation
Note: you'll have to set all the permissions above first, to enable all the events needed below
Event Name
Description
Create
Branch or tag created.
Delete
Branch or tag deleted.
Push
Git push to a repository.
Repository
Repository created, deleted, archived, unarchived, publicized, or privatized.

Where can this GitHub App be installed?

If you're forking for the purpose of using this for your self, or your organization, you should pick "Only on this account".

Generated App Information (Keys & Secrets)

Once created, GitHub will generate a few key items you'll need to pass to Colophon:
name
environment variable
App ID
GITHUB_APP_ID
Client ID
GITHUB_CLIENT_ID
Client secret
GITHUB_CLIENT_SECRET
Public link
GITHUB_APP_LINK

Generating a Private key

You need a private key to sign access token requests to GitHub.
Click "Generate Private Key" and store the downloaded .pem file somewhere safe. You'll need to use this for the app environment configuration