on master help sign in
github-app/README.md
25 lines 966 B history raw
1# Authenticate as a GitHub App
3This library provides functions that help with authenticating as a [GitHub App][ghapp].
6## Use
81. [Register][reg] your App with GitHub to obtain an App ID and a private key.
92. Using the data from the step above, create `AppAuth`.
103. For each installation of your app, get an `InstallationAuth` using `mkInstallationAuth`.
114. Use the `executeAppRequest` function to execute requests.
12 Behind the scenes, this function exchanges the installation auth token for
13 a regular access token, caches it, and renews as needed.
15See [serokell/github-ops-access][ghopsa] for a real-life example use.
17[ghapp]: https://developer.github.com/apps/
18[reg]: https://github.com/settings/apps
19[ghopsa]: https://github.com/serokell/github-ops-access/blob/test/webhook/Main.hs
22## About Serokell
24This library is maintained and funded with ❤️ by [Serokell](https://serokell.io/).
25The names and logo for Serokell are trademark of Serokell OÜ.