https://github.com/gr2m/octokit-app-example
An example GitHub app implemented using Octokit libraries
https://github.com/gr2m/octokit-app-example
Last synced: 3 months ago
JSON representation
An example GitHub app implemented using Octokit libraries
- Host: GitHub
- URL: https://github.com/gr2m/octokit-app-example
- Owner: gr2m
- License: mit
- Created: 2020-10-21T17:49:34.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-03-05T06:48:11.000Z (over 5 years ago)
- Last Synced: 2024-04-22T13:23:28.003Z (about 2 years ago)
- Language: JavaScript
- Homepage:
- Size: 44.9 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# octokit-app-example
An example GitHub app implemented using `@octokit/*` libraries.
The app does 3 common things.
1. Sends a request authenticated as the app itself (JWT). In this case, it retrieves information about itself.
2. Iterates through all installations, authenticates as each installation, then iterates through all repositories. In this example, it creates a [`repository_dispatch` event](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#create-a-repository-dispatch-event).
3. It acts on webhook events. The example simulates the retrieval of an `issues.opened` event for [gr2m/sandbox#143](https://github.com/gr2m/sandbox/issues/143). It authenticates as the according installation and creates a comment on the issue.
I use this example as a base of discussion on how to simplify the existing APIs.
## Changes
1. [initial version of the code](https://github.com/gr2m/octokit-app-example/blob/19e35f944c058c88618fda0e53fbed41be115b32/index.js)
2. Derive installation octokit from app octokit: [changes](https://github.com/gr2m/octokit-app-example/pull/2/files) (-20 LOC)
3. Use [`@octokit/app`](https://github.com/octokit/app.js/): [changes](https://github.com/gr2m/octokit-app-example/pull/3/files) (-50 LOC)
## Local setup
In order to test the code, you will have to [register a new GitHub app](https://github.com/organizations/octokit/settings/apps/new). The app requires read & write access for
1. content
2. issues
You can disable webhooks.
Then copy `.env.example` to `.env` and set the values to the credentials of your GitHub app registration.
Then install the app on a test repository. In that repository, create a new issue. Update the `webhooks.receive()` in the example with the repository owner, name and the issue number of your example issue.
## License
[MIT](LICENSE)