Git Product home page Git Product logo

jcore's Introduction

JCore - Java library for GitHub workflow commands

DocumentationIssues

Java CI Maven Central version license

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

GitHub Copilot

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.

jcore's People

Contributors

dependabot[bot] avatar katsute avatar

jcore's Issues

Markdown summary

Prerequisites

  • I have checked that no other similar feature request already exists.
  • This feature request makes sense for the project.
  • I have checked that this feature does not already exist.
  • I am running the latest release version.

Feature

Add markdown summary, also to tests.
https://github.blog/changelog/2022-05-09-github-actions-enhance-your-actions-with-job-summaries/
https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/

Write to the file specified in env GITHUB_STEP_SUMMARY.

Reason

Already added to GitHub runners.

Add notice supplier

Prerequisites

  • I have checked that no other similar feature request already exists.
  • This feature request makes sense for the project.
  • I have checked that this feature does not already exist.
  • I am running the latest release version.

Feature

Add notice supplier

Reason

Same as error and warning supplier

[external] Error/warning file/line/col doesn't work

Prerequisites

If all checks are not passed then the issue will be closed.

  • I have checked that no other similar issue already exists.
  • I have checked that this issue is actually a bug and not a feature.
  • I am running the latest release version.

Release Version: Release version or branch commit where the issue occurred.
main

Issue

Explain your issue. Add any relevant code or stacktraces here.
This is an external issue. The error/warning commands don't work with file/line/col parameters.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.