Jenkins GitHub Apps Authentication & Checks API

Presenters: Tim Jacomb and Kezhi Xiong. Meetup will be held in Zoom Webinar, RSVP to see the link. Time: 1PM UTC, Aug 19.

GitHub Apps authentication support was released in April as a part of the GitHub Branch Source plugin. It is a huge improvement for the Jenkins community, especially for users using Multi-Branch Pipeline and GitHub Org folders. It brings us many benefits: larger rate limits, user-independent authentication, improved security and fine-grained permissions, access to GitHub Checks API.

Based on GitHub Apps authentication support, we have recently released an initial version of Checks API plugin and GitHub Checks plugin. The two plugins are about defining and implementing the checks API in Jenkins. By consuming this API, other plugins can easily create GitHub checks. Thus, any information during a Jenkins build like warnings from static analysis tools, code coverage, and test results can be directly shown on GitHub UI.

In this webinar, we will go through the benefits of GitHub Apps,how to set them up for Jenkins, how to consume the checks API in Jenkins plugins or pipelines and show you examples on how we used the API to report static analysis issues and code coverage to GitHub.

References:

• GitHub Apps Authentication Blogpost: https://www.jenkins.io/blog/2020/04/16/github-app-authentication/
• GitHub Checks API project update: https://www.jenkins.io/blog/2020/08/03/github-checks-api-plugin-coding-phase-2/
• Checks API Plugin: https://github.com/jenkinsci/checks-api-plugin
• GitHub Checks Plugin: https://github.com/jenkinsci/github-checks-plugin
• Warnings NG plugin: https://plugins.jenkins.io/warnings-ng/
• Code Coverage API plugin: https://plugins.jenkins.io/code-coverage-api