README.md

JCore - Java library for GitHub workflow commands

Documentation • Issues

Overview

JCore supports most GitHub workflow commands.

• Inputs

  Workflow.getInput("input")

• Logging

  Workflow.info("info");
  Workflow.debug("debug");
  Workflow.notice("notice");
  Workflow.warning("warning");
  Workflow.error("error");

• AnnotationProperties

  new AnnotationProperties.Builder()
     .title("A title")
     .startColumn(1)
     .endColumn(2)
     .startLine(3)
     .endLine(4)
     .build()

• Groups

  Workflow.startGroup("my-group");

• Secret masking

  Workflow.addMask("secret value");

View all features in the documentation

JUnit Integration

Add JCore to your JUnit test cases in order to see failures as annotations.

❌ without JCore

Assertions.assertTrue(false);

Assumptions.assumeTrue(false);

• No warning messages.
• Requires reading Maven log to find warnings and errors.

✔ with JCore

Workflows.annotateTest(() -> Assertions.assertTrue(false));

Workflows.annotateTest(() -> Assumptions.assumeTrue(false));

• Annotations show warnings and errors.
• Full stack traces in annotations.
• Direct links to line error.

Contributing

GitHub Copilot is strictly prohibited on this repository.
Pulls using this will be rejected.

• Found a bug? Post it in issues.
• Want to further expand our project? Fork this repository and submit a pull request.

License

This library is released under the GNU General Public License (GPL) v2.0.