https://github.com/julbme/java-sdk-github-actions

Java SDK for GitHub actions
https://github.com/julbme/java-sdk-github-actions

github-actions java sdk

Last synced: 28 days ago
JSON representation

Java SDK for GitHub actions

• Host: GitHub
• URL: https://github.com/julbme/java-sdk-github-actions
• Owner: julbme
• License: mit
• Created: 2022-02-11T08:18:09.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-12-03T21:08:35.000Z (over 3 years ago)
• Last Synced: 2025-01-12T21:13:00.182Z (over 1 year ago)
• Topics: github-actions, java, sdk
• Language: Java
• Homepage: https://julbme.github.io/java-sdk-github-actions/
• Size: 716 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build](https://github.com/julbme/java-sdk-github-actions/actions/workflows/maven-build.yml/badge.svg)](https://github.com/julbme/java-sdk-github-actions/actions/workflows/maven-build.yml)

[![Lint Commit Messages](https://github.com/julbme/java-sdk-github-actions/actions/workflows/commitlint.yml/badge.svg)](https://github.com/julbme/java-sdk-github-actions/actions/workflows/commitlint.yml)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=julbme_java-sdk-github-actions&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=julbme_java-sdk-github-actions)

![Maven Central](https://img.shields.io/maven-central/v/me.julb/sdk-github-actions)

# Java SDK for GitHub actions

This SDK provides utility methods to build GitHub Actions in Java.

It is heavily inspired of GitHub Actions [core toolkit](https://github.com/actions/toolkit/tree/main/packages/core) available in *TypeScript*.

This SDK provides the following capabilities:

* Read inputs: `getInput`, `getMultilineInput`, `getBooleanInput`

* Write output variables: `setOutput`, `setEmptyOutput`

* Mask secret variables: `setSecret`

* Run operations within groups: `startGroup`, `endGroup`, `group` with closure

* Save and retrieve state: `saveState`, `getState`

* Log messages: `debug`, `notice`, `warning`, `error`

* Quick access to GitHub Actions [default environment variables](https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables)

## Documentation

* [Getting started](https://github.com/julbme/java-sdk-github-actions/wiki/Getting-Started)

* [Usage guide](https://github.com/julbme/java-sdk-github-actions/wiki/Usage)

* [JavaDoc](https://julbme.github.io/java-sdk-github-actions/apidocs/index.html)

## Contributing

This project is totally open source and contributors are welcome.