quarkus-github-action

KO | EN

gitlite — search

#javascript #python #ruby #php #hacktoberfest #java #html #blog #dotfiles #game #minecraft #cplusplus

quarkus-github-action

★ 27 Open GitHub ↗

Develop your GitHub Actions in Java with Quarkus.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Quarkus GitHub Action

[![Version](https://img.shields.io/maven-central/v/io.quarkiverse.githubaction/quarkus-github-action?logo=apache-maven&style=for-the-badge)](https://central.sonatype.com/artifact/io.quarkiverse.githubaction/quarkus-github-action)

[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=for-the-badge)](https://raw.githubusercontent.com/quarkiverse/quarkus-github-action/main/)

**Develop your GitHub Actions in Java with Quarkus**

> [!TIP]
> Interested in GitHub Apps? Have a look at the [Quarkus GitHub App extension](https://github.com/quarkiverse/quarkus-github-app/).

Quarkus GitHub Action is a [Quarkus](https://quarkus.io) extension
that allows to create GitHub Actions in Java with very little boilerplate.

And yes, it supports generating native executables with GraalVM or Mandrel.

Your GitHub Action will look like:

```java
class MyAction {

@Action
  void doSomething() {
    // do something useful here
  }
}
```

Or you can also leverage the GitHub REST API (GraphQL is also supported), get the execution context, get the inputs, execute commands... with something a bit more involved:

```java
class MyAction {

@Action
  void onIssueOpened(@Issue.Opened GHEventPayload.Issue issuePayload, Context context, Inputs inputs, Commands commands) throws IOException {
    // Add a comment to the issue who triggered the job
    issuePayload.getIssue().comment("Hello from MyAction");

// Set the value of an output
    commands.setOutput("output-key", "the value");

// Append Markdown to the job summary
    commands.appendJobSummary(":wave: Hello from Quarkus GitHub Action");
  }
}
```

Quarkus GitHub Action will automatically inject all these fully initialized instances in the `@Action` methods for you.

Focus on your business logic and don't bother about the ceremony.

## Compatibility

Quarkus GitHub Action 2.x is compatible with Quarkus 3.x.

We recommend using the latest versions of both for the best experience.

## Documentation

To get you started (and more!), please refer to [the extensive documentation](https://quarkiverse.github.io/quarkiverse-docs/quarkus-github-action/dev/index.html).

Anything unclear or missing in the documentation? Please [open an issue](https://github.com/quarkiverse/quarkus-github-action/issues/new), we will address it quickly.

## Examples

* [Conversational Release Action](https://github.com/quarkusio/conversational-release-action) - used to release Quarkus
* [Build Reporter Action](https://github.com/quarkusio/action-build-reporter/) - used to generate a build report from the Surefire reports and more
* [Monitor Artifact Publication Action](https://github.com/quarkusio/monitor-artifact-publication-action) - used to monitor the publication of a Maven artifact to Maven Central
* [Maven Lockfile Action](https://github.com/chains-project/maven-lockfile) - used to check a project is in line with Maven Lockfile requirements
* [Pom to Badges Action](https://github.com/janpk/pom-to-badges) - used to generate badges from the dependencies of a project

## How?

The Quarkus GitHub Action extension uses the [Hub4j GitHub API](https://github.com/hub4j/github-api)
to parse the webhook payloads and handle the [GitHub REST API](https://docs.github.com/en/rest) calls.

It can also execute GraphQL queries towards the [GitHub GraphQL API](https://docs.github.com/en/graphql) via the SmallRye GraphQL Client.

The rest of the extension is Quarkus magic - mostly code generation with [Gizmo](https://github.com/quarkusio/gizmo/) -
to get everything wired.

## Status

This extension is considered stable and is used in production.

It relies on the exact same principles as the [Quarkus GitHub App extension](https://github.com/quarkiverse/quarkus-github-app/).

## License

This project is licensed under the [Apache License Version 2.0](./LICENSE.txt).

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<table>
  <tbody>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="https://lesincroyableslivres.fr/"><img src="https://avatars.githubusercontent.com/u/1279749?v=4?s=100" width="100px;" alt="Guillaume Smet"/><br /><sub><b>Guillaume Smet</b></sub></a><br /><a href="https://github.com/quarkiverse/quarkus-github-action/commits?author=gsmet" title="Code">💻</a> <a href="#maintenance-gsmet" title="Maintenance">🚧</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/janpk"><img src="https://avatars.githubusercontent.com/u/809194?v=4?s=100" width="100px;" alt="Jan-Petter Krüger"/><br /><sub><b>Jan-Petter Krüger</b></sub></a><br /><a href="https://github.com/quarkiverse/quarkus-github-action/commits?author=janpk" title="Code">💻</a></td>
    </tr>
  </tbody>
</table>

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

quarkus-github-action

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README