GitHub Checks

Version: 1.0.4Minimum Jenkins requirement: 2.204.6ID: github-checks
Installs: 210
Last released:
Maintainers
Ullrich Hafner

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

GitHub Checks Plugin Cover

This plugin publishes checks to GitHub through GitHub Checks API. It implements the extension points defined in Checks API Plugin.

This plugin has been installed, alone with the General API Plugin 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.

Features

Prerequsite: only GitHub App with proper permissions can publish checks, this guide helps you authenticate your Jenkins as a GitHub App.

Build Status Check

GitHub Status

This plugin implements the status checks feature from Checks API Plugin to publish statuses (pending, in progress, and completed) to GitHub.

You can customize it by configuring the "Status Checks Properties" behavior for your GitHub Source SCM (similar behaviour for Git SCM will be provided soon):

Status Checks Properties

Note: If you are using GitHub Branch Source Plugin, it will also send status notifications to GitHub through Status API. You can disable it by using Disable GitHub Multibranch Status Plugin or Skip Notification Trait Plugin.

Rerun Failed Build

Failed Checks

If your Jenkins build failed, a failed check will be published here. A "Re-run" button will be added automatically by GitHub, by clicking it, you can schedule a new build for the last commit of this branch.

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
Links
Labels