- Provides query handlers for GitHub user, repository and issue search.
- Triggered queries perform a GitHub search.
- Global queries return customizable saved searches.
- The root trigger queryhandler returns the saved searches of the dedicated search handlers.
- Authentication allows for private access and higher rate limits.
GitHub has a complex rate limiting system. Limits of unauthenticated API queries are hit quickly. Use authentication to avoid getting limited (see the section below).
- Create an OAuth app on GitHub. (GitHub docs)
- Give it a name.
- Give it a random website.
- Add Redirect URI
albert://github/
. - Click Register application.
- Click Generate a new client secret.
- Insert Client ID and Client secret in the plugin settings and click the authorize button.
- Uses the GitHub Web API (API version: v2022-11-28).
- See the used endpoints and scopes in
github.h
.