Actions Toolkit for Java

The GitHub ToolKit for developing GitHub Actions in Java

License

License

MIT
Categories

Categories

Java Languages
GroupId

GroupId

com.github.kjens93.actions.toolkit
ArtifactId

ArtifactId

actions-toolkit-java
Last Version

Last Version

1.1.12
Release Date

Release Date

Type

Type

pom
Description

Description

Actions Toolkit for Java
The GitHub ToolKit for developing GitHub Actions in Java
Project URL

Project URL

https://github.com/Kjens93/actions-toolkit-java
Project Organization

Project Organization

com.github.Kjens93
Source Code Management

Source Code Management

https://github.com/Kjens93/actions-toolkit-java

Download actions-toolkit-java

How to add to project

<!-- https://jarcasting.com/artifacts/com.github.kjens93.actions.toolkit/actions-toolkit-java/ -->
<dependency>
    <groupId>com.github.kjens93.actions.toolkit</groupId>
    <artifactId>actions-toolkit-java</artifactId>
    <version>1.1.12</version>
    <type>pom</type>
</dependency>
// https://jarcasting.com/artifacts/com.github.kjens93.actions.toolkit/actions-toolkit-java/
implementation 'com.github.kjens93.actions.toolkit:actions-toolkit-java:1.1.12'
// https://jarcasting.com/artifacts/com.github.kjens93.actions.toolkit/actions-toolkit-java/
implementation ("com.github.kjens93.actions.toolkit:actions-toolkit-java:1.1.12")
'com.github.kjens93.actions.toolkit:actions-toolkit-java:pom:1.1.12'
<dependency org="com.github.kjens93.actions.toolkit" name="actions-toolkit-java" rev="1.1.12">
  <artifact name="actions-toolkit-java" type="pom" />
</dependency>
@Grapes(
@Grab(group='com.github.kjens93.actions.toolkit', module='actions-toolkit-java', version='1.1.12')
)
libraryDependencies += "com.github.kjens93.actions.toolkit" % "actions-toolkit-java" % "1.1.12"
[com.github.kjens93.actions.toolkit/actions-toolkit-java "1.1.12"]

Dependencies

compile (2)

Group / Artifact Type Version
org.projectlombok : lombok Optional jar 1.18.16
org.apache.commons : commons-lang3 jar 3.11

test (3)

Group / Artifact Type Version
junit : junit Optional jar 4.13.1
org.assertj : assertj-core Optional jar 3.18.1
com.github.stefanbirkner : system-rules Optional jar 1.19.0

Project Modules

  • actions-toolkit-core

Actions Toolkit

GitHub Actions status Maven Central

Actions Toolkit for Java

The GitHub Actions ToolKit for Java provides a set of packages to make creating actions easier. This software is not endorsed, distributed, or maintained by GitHub. This library is an unofficial Java port of GitHub Actions Toolkit, which was originally developed exclusively for JavaScript.

Getting Started

Java actions are not officially supported by GitHub. As such, you will need to use a Docker action to run your action code.

The toolkit is available from Maven Central.

Packages

โœ”๏ธ actions-toolkit-core (Complete!)

Provides functions for inputs, outputs, results, logging, secrets and variables. Read more here

<dependency>
  <groupId>com.github.kjens93.actions.toolkit</groupId>
  <artifactId>actions-toolkit-core</artifactId>
  <version>${actions-toolkit.version}</version>
</dependency>

๐Ÿƒ actions-toolkit-exec (not started)

Provides functions to exec cli tools and process output. Read more here


๐Ÿจ actions-toolkit-glob (not started)

Provides functions to search for files matching glob patterns. Read more here


โœ๏ธ actions-toolkit-io (not started)

Provides disk i/o functions like cp, mv, rmRF, find etc. Read more here


๐Ÿ”จ actions-toolkit-cache (not started)

Provides functions for downloading and caching tools. e.g. setup-* actions. Read more here


:octocat: actions-toolkit-github (not started)

Provides a GitHub client hydrated with the context that the current action is being run in. Read more here


๐Ÿ’พ actions-toolkit-artifact (not started)

Provides functions to interact with actions artifacts. Read more here


Creating an Action with the Toolkit

โ“ Choosing an action type

Outlines the differences and why you would want to create a JavaScript or a container based action.

โžฐ Versioning

Actions are downloaded and run from the GitHub graph of repos. This contains guidance for versioning actions and safe releases.

โš ๏ธ Problem Matchers

Problem Matchers are a way to scan the output of actions for a specified regex pattern and surface that information prominently in the UI.

โš ๏ธ Proxy Server Support

Self-hosted runners can be configured to run behind proxy servers.

Contributing

Contributions are welcome. See how to contribute.

com.github.kjens93.actions.toolkit

Kyler Jensen

Versions

Version
1.1.12
1.1.10
1.1.9
1.1.8
1.1.7
1.1.6
1.1.5
1.1.2
1.1.1
1.1.0
1.0.1
1.0.0