Actions Toolkit for Java

The GitHub ToolKit for developing GitHub Actions in Java

License	MIT
Categories	Java Languages
GroupId	com.github.kjens93
ArtifactId	actions-toolkit-java
Last Version	1.0.0
Release Date	Mar 25, 2020
Type	pom
Description	Actions Toolkit for Java The GitHub ToolKit for developing GitHub Actions in Java
Project URL	https://github.com/Kjens93/actions-toolkit-java
Project Organization	com.github.Kjens93
Source Code Management	https://github.com/Kjens93/actions-toolkit-java

Download actions-toolkit-java

Filename	Size
actions-toolkit-java-1.0.0.pom	4 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.github.kjens93/actions-toolkit-java/ -->
<dependency>
    <groupId>com.github.kjens93</groupId>
    <artifactId>actions-toolkit-java</artifactId>
    <version>1.0.0</version>
    <type>pom</type>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.github.kjens93/actions-toolkit-java/
implementation 'com.github.kjens93:actions-toolkit-java:1.0.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.github.kjens93/actions-toolkit-java/
implementation ("com.github.kjens93:actions-toolkit-java:1.0.0")

Apache Buildr

'com.github.kjens93:actions-toolkit-java:pom:1.0.0'

Apache Ivy

<dependency org="com.github.kjens93" name="actions-toolkit-java" rev="1.0.0">
  <artifact name="actions-toolkit-java" type="pom" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.github.kjens93', module='actions-toolkit-java', version='1.0.0')
)

Scala SBT

libraryDependencies += "com.github.kjens93" % "actions-toolkit-java" % "1.0.0"

Leiningen

[com.github.kjens93/actions-toolkit-java "1.0.0"]

Dependencies

compile (2)

Group / Artifact	Type	Version
org.projectlombok : lombok	jar	1.18.12
org.apache.commons : commons-lang3	jar	3.9

test (3)

Group / Artifact	Type	Version
junit : junit	jar	4.13
org.assertj : assertj-core	jar	3.15.0
com.github.stefanbirkner : system-rules	jar	1.19.0

Project Modules

• actions-toolkit-core

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

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.

Kyler Jensen

Versions

Version
1.0.0 Mar 25, 2020