Quarkus GitHub App
Develop your GitHub Apps in Java with Quarkus.
Quarkus GitHub App is a Quarkus extension that allows to create GitHub Apps in Java with very little boilerplate.
Think of it as Probot for Java.
And yes, it supports generating native executables with GraalVM or Mandrel.
Your application will look like:
class MyGitHubApp {
void onOpen(@Issue.Opened GHEventPayload.Issue issuePayload) throws IOException {
issuePayload.getIssue().comment("Hello from MyGitHubApp");
}
}
And that's it.
The code above listens to the issues.opened
GitHub event and posts a comment in each opened issue.
That's for the basics but it also supports YAML or JSON config files in your repository.
Finally, it supports using a Smee.io proxy during the development of the app.
Documentation
To get you started (and more!), please refer to the documentation.
Anything missing in the documentation? Please open an issue.
How?
The Quarkus GitHub App extension uses the Hub4j GitHub API to parse the webhook payloads and handle the GitHub REST API calls.
The rest of the extension is Quarkus magic - mostly code generation with Gizmo - to get everything wired.
It also leverages Reactive Routes, CDI events (both sync and async), and Caffeine.
Status
The extension is already well polished and stable.
Work is still needed on the test infrastructure though.
We are making steady progress on it.
License
This project is licensed under the Apache License Version 2.0.
Contributors
✨
Thanks goes to these wonderful people (emoji key):
Guillaume Smet |
Yoann Rodière |
This project follows the all-contributors specification. Contributions of any kind welcome!