194

votes

Is there a way to show the Jenkins build status on my project's GitHub Readme.md?

I use Jenkins to run continuous integration builds. After each commit it ensures that everything compiles, as well as executes unit and integration tests, before finally producing documentation and release bundles.

There's still a risk of inadvertently committing something that breaks the build. It would be good for users visiting the GitHub project page to know the current master is in that state.

githubjenkins

Why was this down-voted? Is there something obvious in the Jenkins user-guide that I missed? I did google before-hand, and couldn't find anything. – Jasper Blues

The Travis build server can do something like this, but I'm using Jenkins on Osx. Here's the kind of thing I'm after: github.com/CocoaPods/CocoaPods – Jasper Blues

possible duplicate of How do show my tests passing/failing in Github? – random

The link to the similar question recommends Travis, which doesn't currently support iOS and OSX, so it does not answer the question. – Jasper Blues

This is not a duplicate.. travis != jenkins – Banjocat

173

votes

Ok, here's how you can set up Jenkins to set GitHub build statuses. This assumes you've already got Jenkins with the GitHub plugin configured to do builds on every push.

Go to GitHub, log in, go to Settings, Personal access tokens, click on Generate new token.
Check repo:status (I'm not sure this is necessary, but I did it, and it worked for me).
Generate the token, copy it.
Make sure the GitHub user you're going to use is a repository collaborator (for private repos) or is a member of a team with push and pull access (for organization repos) to the repositories you want to build.
Go to your Jenkins server, log in.
Manage Jenkins → Configure System
Under GitHub Web Hook select Let Jenkins auto-manage hook URLs, then specify your GitHub username and the OAuth token you got in step 3.
Verify that it works with the Test Credential button. Save the settings.
Find the Jenkins job and add Set build status on GitHub commit to the post-build steps

That's it. Now do a test build and go to GitHub repository to see if it worked. Click on Branches in the main repository page to see build statuses.

sceenshot of the main page where you click on 'branches'

You should see green checkmarks:

screenshot of GitHub branches with build status

66

votes

In the meanwhile the UI of Jenkins and GitHub has changed a bit and it took me a while to figure out how to configure Jenkins now correctly. The explanation here is based on Jenkins version 2.121.1.

I also assume that you have already configured your Jenkins Job be triggered by a webhook or by polling. Those are the steps that I have taken to get it working:

Configure Github: Create Personal Access Token with OAuth Scope repo:status
Configure Jenkins: Configure System and add the OAuth Secret as a GitHub Server - use Secret Text as an authentication method to put the OAuth Secret in there.
Configure your Jenkins Job: Add Set GitHub commit status as Post-build action. Set the Status Result to One of the default messages and statuses.
Check your result on GitHub: Check if you get the build status and build execution duration on your GitHub commit.

Configure Github

Configure Jenkins

Configure Jenkins Job

Result

You will now see the status for your commits and branches:

36

votes

What I did is quite simple:

Install the Hudson Post Task Plugin
Create a Personal Access Token here : https://github.com/settings/tokens

Add a Post Task Plugin that always put success

curl -XPOST -H "Authorization: token OAUTH TOKEN" https://api.github.com/repos/:organization/:repos/statuses/$(git rev-parse HEAD) -d "{
  \"state\": \"success\",
  \"target_url\": \"${BUILD_URL}\",
  \"description\": \"The build has succeeded!\"
}"

Add a Post Task Plugin that will put failure if "marked build as failure"

curl -XPOST -H "Authorization: token OAUTH TOKEN" https://api.github.com/repos/:organization/:repos/statuses/$(git rev-parse HEAD) -d "{
  \"state\": \"failure\",
  \"target_url\": \"${BUILD_URL}\",
  \"description\": \"The build has failed!\"
}"

You can also add a call to pending at the beginning of tests

curl -XPOST -H "Authorization: token OAUTH TOKEN" https://api.github.com/repos/:organization/:repos/statuses/$(git rev-parse HEAD) -d "{
  \"state\": \"pending\",
  \"target_url\": \"${BUILD_URL}\",
  \"description\": \"The build is pending!\"
}"

Screenshot of the Post build task configuration

26

votes

This plugin should work: https://wiki.jenkins-ci.org/display/JENKINS/Embeddable+Build+Status+Plugin

You should be able to embed badges like this into your README.md file:

build passing

11

votes

The Commit Status API allows you to see the "Repo Statuses API".

And since April 26th 2013, you now can see the build status on your GitHub repo branch page:

build status on GitHub repo branches

That means it is another way, by visiting the GitHub project page, to see those statuses instead of having only Jenkins.

Starting April 30th, 2013, the API endpoint for commit statuses has been extended to allow branch and tag names, as well as commit SHAs.

11

votes

There's also this plugin that will give you a badge url that you can post in your README.md and looks like this

build passing

https://wiki.jenkins-ci.org/display/JENKINS/Embeddable+Build+Status+Plugin

7

votes

If you have Github plugin installed on your Jenkins, you can do it in the Post build actions like this :

set build status on github

5

votes

Add below line in your README.md and change both URL according to your jenkins project.

[![Build Status](https://jenkins../..project/lastBuild/buildStatus)](https://jenkins../..project/lastBuild/)

3

votes

In regards with setting up Jenkins and GitHub's protected branch. I'm using Jenkins 2.6, and these are the steps I did to make it work:

On your repository's GitHub webpage:

Navigate to Settings > Branches.
Under Protect branches, click on the Choose a branch drown down menu and select the branch you want to set as a Protected branch.
Enable the options as needed.

On the Jenkins Server: (Make sure you have the Git and GitHub Plugin installed)

Navigate to Manage Jenkins > Configure System.
Under GitHub, set the API URL to https://api.github.com. Though this is the default value.
Select your generated token for the Credentials. If you haven't generated a token yet, click on Advanced... then on Additional actions, you can convert your login and password to token and use it as your credential.

Also, make sure the GitHub account that your Jenkins is using is a collaborator for the repository. I've set it with write permission level.

Hope this helps.

2

votes

I followed the directions from Alex and it worked.

But, for GitHub Enterprise you need to modify the API URL when adding the server to Jenkins.

For example, if your company is creditcard.com, your URL would be

https://github.creditcard.com/api/v3/

1

votes

Jently updates your Github commit status (as described by @vonc above), unfortunately they have yet to implement the Repo Status API

1

votes

Edit:

I'm no longer using this approach, please use one of the other answers.

Update: what I ended up doing, for our specific case: (above answers were great - thanks!)

Because our build server is not on the internet, we have a script to publish the build status to the gh-pages branch in github.

Start of build stamps failing
End of build stamps success
Project runs after main project to publish results -> build-status, API docs, test reports and test coverage.

GitHub caches images, so we created .htaccess file, that instructs a short cache timeout for the build-status image.

Put this in the directory with the build-status image:

ExpiresByType image/png "access plus 2 minutes"

Here's the build script. The target that publishes to gh-pages is '--publish.site.dry.run'

With less than 400 lines of config, we have:

Compile checks
unit & integration tests
Test Reports
Code Coverage Reports
API Docs
Publishing to Github

. . and this script can be run in or outside of Jenkins, so that:

Developers can run this script before commit, reducing the chance of a broken build that impacts others.
A failure is easy to reproduce locally.

The Results:

Project main page has the build status, updated after each build, along with latest API Docs, test results and test coverage.

0

votes

for pipeline projects you can use the post section like so :

void setBuildStatus(String message, String state) {
  step([
      $class: "GitHubCommitStatusSetter",
      reposSource: [$class: "ManuallyEnteredRepositorySource", url: "https://github.com/my-user/my-repo"],
      contextSource: [$class: "ManuallyEnteredCommitContextSource", context: "ci/jenkins/build-status"],
      errorHandlers: [[$class: "ChangingBuildStatusErrorHandler", result: "UNSTABLE"]],
      statusResultSource: [ $class: "ConditionalStatusResultSource", results: [[$class: "AnyBuildResult", message: message, state: state]] ]
  ]);
}

pipeline {
    agent any

    triggers {
        githubPush()
    }

    stages {

        stage('Hello') {
            steps {
                echo 'Hello World'
            }
        }

    }

    post {
        success {
            setBuildStatus("Build succeeded", "SUCCESS");
        }
        failure {
            setBuildStatus("Build failed", "FAILURE");
        }
    }
}

Just change "https://github.com/my-user/my-repo" to meet your github repo.

Reference : https://stackoverflow.com/a/47162309/4261333

Show current state of Jenkins build on GitHub repo

13 Answers

Configure Github

Configure Jenkins

Configure Jenkins Job

Result