Checks API

ID: checks-api

Join the chat at https://gitter.im/jenkinsci/github-checks-api contributions welcome Jenkins GitHub Actions codecov

Inspired by the GitHub Checks API, this plugin aims to provide a general API to allow Jenkins plugins publishing checks (or reports) to remote source code management (SCM) platforms (e.g. GitHub, GitLab, BitBucket, etc.).

By consuming this API, other plugins can publish check with customized parameters for a Jenkins build, such as status, summary, warnings, code annotations, or even images. Implementations of this API decide on how to make use of these parameters and where to publish the checks.

Known consumers:

Implementations:

This plugin, along with it's GitHub implementation, has been installed on ci.jenkins.io to help maintain over 1500 Jenkins plugins. You can take a look at the action for this repository or other plugin repositories under Jenkins organization for the results.

Embedded Features

Build Status Check

GitHub Status

This plugin defines extension points to publish statuses to different SCM platforms.

It depends on the implementation to decide whether to skip them and what name to use.

If enabled, the statuses will be published in different stages of a Jenkins build (enters the queue, checkout, and completes).

Pipeline Usage

  • publishChecks: you can publish checks directly in the pipeline script instead of depending on consumer plugins:
publishChecks name: 'example', title: 'Pipeline Check', summary: 'check through pipeline', text: 'you can publish checks in pipeline script', detailsURL: 'https://github.com/jenkinsci/checks-api-plugin#pipeline-usage'
  • withChecks: you can inject the check's name into the closure for other steps to use:
withChecks(name: 'injected name') {
    // some other steps that will extract the name
}

Guides

Contributing

Refer to our contribution guidelines

Acknowledgements

This plugin was started as a Google Summer of Code 2020 project, special thanks to the support from Jenkins GSoC SIG and the entire community.

LICENSE

Licensed under MIT, see LICENSE

ArchivesGet past versions
Version: 1.2.0
Released:
Requires Jenkins 2.204.6
Installs: 96,084
Maintainers
Ullrich Hafner
Help us improve this page!
To propose a change submit a pull request to the plugin page on GitHub.