Albert plugin: GitHub

Features

• Provided query handlers:
  • GitHub user search (users and organizations)
  • GitHub repository search
  • GitHub issue search (issues and pull requests)
  • Saved searches
• Item actions
  • User / Organization
    • Show on GitHub.
  • Repository
    • Show on GitHub.
    • Show issues on GitHub.
    • Show pull requests on GitHub.
    • Show discussions on GitHub.
    • Show wiki on GitHub.
  • Issue / Pull request
    • Show on GitHub.
  • Saved search
    • Run.
    • Run on GitHub.
• Authentication allows for private access and higher rate limits.
• Search handlers fetch results on demand (infinite scroll).

Note

GitHub has a complex rate limiting system. Authenticated access has higher rate limts. For Albert this means you get faster average response times.

Authenticated access

1. Create an OAuth app on GitHub. (GitHub docs)
2. Give it a name.
3. Give it a random website.
4. Add Redirect URI albert://github/.
5. Click Register application.
6. Click Generate a new client secret.
7. Insert Client ID and Client secret in the plugin settings and click the authorize button.

Why that complicated?

1. Shipping embedded credentials introduces an external dependency (that may break functionality).
2. Shipping embedded credentials in an open source project is difficult to distribute.

Technical notes

• Uses the GitHub Web API (API version: v2022-11-28).
• See the used endpoints and scopes in github.h.