GitHub Checks API for Jenkins Plugins
Goal: Create a new plugin API so that plugins can publish GitHub checks status messages
Status: Completed
Team
-
Student:
Kezhi Xiong
-
Mentor(s):
Ullrich Hafner ,
Tim Jacomb
-
Advisor(s):
Jeff Pearce
Details
The GitHub Checks API allows developers to report the CI integrations’ detail information rather than the binary pass/fail build status on GitHub pages. This project is about implementing this API as a new Jenkins plugin. By consuming this API, other plugins can easily create GitHub checks. Thus, any information during the Jenkins process like warnings, summaries, and durations can be directly shown on GitHub pages.
Project Deliverables
-
A new Jenkins plugin (Checks API Plugin) that defines the general checks API
-
A new Jenkins plugin (GitHub Checks Plugin) that implements the general checks API for GitHub
-
A new feature (pull request #550) for Warnings Next Generation Plugin to report warnings to GitHub by consuming the checks API
-
A new feature (pull request #169) for Code Coverage API Plugin to report code coverage to GitHub by consuming the checks API
-
Pipeline support feature (pull request #7) to allow users to publish checks from their pipeline
-
Rerun support feature (pull request #25) on GitHub to allow users requesting a rebuild for failed builds
Phase 2 Works
-
Consume the API in Warnings Next Generation plugin as a new feature (pull request #550)
-
Consume the API in Code Coverage API plugin as a new feature (pull request #169)
-
Deploy Checks API Plugin and GitHub Checks Plugin to ci.jenkins.io and enable the warning checks features
Phase 3 Works
-
Add pipeline support feature (pull request #7) for publishing customized checks
-
Add rerun request feature (pull request #25) for failed GitHub checks
-
Host an online meetup, slides
-
Write consumers guide and implementation guide
Meeting
-
We hosted 14 meetings during the whole GSoC 2020, you can find the details in the meeting notes.
Links
On this page
Connect
Recent Blog Posts
- Log from Jenkins Jobs to GitHub Pull Requests as Checks
- GitHub sponsors the Jenkins project
- Google Summer of Code 2020 summary
- GitHub Checks API Plugin Project - Coding Phase 3
- Custom Distribution Service : Phase 3 Blogpost
- Git Plugin Performance Improvement: Final Phase and Release
- Jenkins Windows Services: YAML Configuration Support - GSoC Project Results
- Machine Learning Plugin project - Coding Phase 3 blog post
- External Fingerprint Storage Phase-3 Update: Introducing the PostgreSQL Fingerprint Storage Plugin
- Custom Distribution Service : Phase 2 Blogpost