Skip to content
This repository has been archived by the owner on Jun 15, 2023. It is now read-only.

Latest commit

 

History

History
125 lines (69 loc) · 4.34 KB

app.md

File metadata and controls

125 lines (69 loc) · 4.34 KB

Creating a GitHub App

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:

  • Personal Accounts: https://github.com/settings/apps/new
  • GitHub Accounts https://github.com/organizations/[your-org-name]/settings/apps/new

You'll be asked provide details for the app, here are the required values:

GitHub App name

Can be anything, suggest using colophon + you-org-name as a suffix

e.g. my-company-colophon

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

e.g. https://colophon.my-company.com/auth/callback

Webhook URL

Events will POST to this URL.

Use the root url of the app https://your-app-domain

e.g. https://colophon.my-company.com/

Webhook secret (optional)

While optional, this is recommended to ensure your Colophon data is secure from external manipulation

e.g. oopee2Ie-Noethoh0-eoS6xah4-yeemeu9U

Permissions

Repository contents ℹ️

Repository contents, commits, branches, downloads, releases, and merges.

Access: Read-only

Repository metadata ℹ️

Access: Read-only

Organization members ℹ️

Access: Read-only

Events

Note: you'll have to set all the permissions above first, to enable all the events needed below

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".

Note: We provide a hosted public service at https://colophon.id

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