{"id":13811,"date":"2018-11-27T01:25:11","date_gmt":"2018-11-27T01:25:11","guid":{"rendered":"https:\/\/app14743.cloudwayssites.com\/blog\/?p=3811"},"modified":"2024-11-14T10:24:51","modified_gmt":"2024-11-14T15:24:51","slug":"how-to-update-jenkins-build-status-in-github-pull-requests-step-by-step-tutorial","status":"publish","type":"post","link":"https:\/\/app14743.cloudwayssites.com\/blog\/how-to-update-jenkins-build-status-in-github-pull-requests-step-by-step-tutorial\/","title":{"rendered":"How to update Jenkins build status in GitHub pull requests [Step-by-Step Tutorial]"},"content":{"rendered":"\n

I regularly use Jenkins CI<\/a> and GitHub<\/a> to help our customers integrate Applitools<\/a> into their continuous integration workflow. Even though I\u2019m pretty familiar with both tools, one thing drives me nuts.<\/p>\n\n\n\n

Here\u2019s the problem: I can\u2019t see Jenkins build status in my GitHub repo pull request. Below is a screenshot of a typical GitHub pull request. As you can see, there\u2019s no indication of my Jenkins build status.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

This forces me to leave GitHub and go to Jenkins every time I merge, just so I can check the build status.<\/p>\n\n\n\n

Doing this once is no big deal. But after doing this for a hundred pull requests, I feel like pulling my hair out (and that would just look weird).<\/p>\n\n\n\n

This is especially frustrating since other continuous integration servers, like Travis<\/a> and Circle CI<\/a>, make this easy.<\/p>\n\n\n\n

Since Jenkins is the third most popular continuous integration tool<\/a> used with GitHub (after Travis and Circle CI), you\u2019d think this issue would have been solved.<\/p>\n\n\n\n

But when I started looking online for a way to solve this issue. I found some good resources, but not one document that described the process from beginning to end with all the configurations needed.<\/p>\n\n\n\n

So, to spare you the pain I\u2019ve gone through trying to make this work, I wrote this end-to-end tutorial on how to update Jenkins build status in the GitHub pull request page.<\/p>\n\n\n\n

So let\u2019s dive in!<\/p>\n\n\n\n

The Big Picture<\/h2>\n\n\n\n

To get a better understanding of the interaction between those tools and the problem they present, see the following diagram. The red marks are the parts that are missing and this post is attempting to fix.<\/p>\n\n\n

\n
\"Integrating<\/figure><\/div>\n\n\n

Get the basics in place<\/h2>\n\n\n\n

To follow the steps below, you just need a couple of things:<\/p>\n\n\n\n

    \n
  1. A GitHub<\/a> account.<\/li>\n\n\n\n
  2. A Jenkins server up<\/a> and running on a static URL<\/a>.<\/li>\n<\/ol>\n\n\n\n

    What you will do in this tutorial:<\/h2>\n\n\n\n
      \n
    1. Setup GitHub\n
        \n
      1. Install Jenkins plugin<\/li>\n\n\n\n
      2. Generate a GitHub access token<\/li>\n<\/ol>\n<\/li>\n\n\n\n
      3. Setup Jenkins\n
          \n
        1. Install Hudson Post Build Task plugin<\/li>\n\n\n\n
        2. Call the GitHub API<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n\n\n\n

             3) Bask in the awesomeness of your technical prowess<\/p>\n\n\n\n

          Setup GitHub<\/h2>\n\n\n\n

          So, how to get GitHub set up with Jenkins? These steps explain.<\/p>\n\n\n\n

          What you\u2019ll do here is install the Jenkins plugin on your GitHub repository in order to trigger a build in Jenkins when you commit a change in GitHub. This way, Jenkins can run tests to make sure your code is working as expected.<\/p>\n\n\n\n

          On your GitHub account, go to your repository and configure a webhook to the Jenkins server:<\/p>\n\n\n\n

            \n
          1. In your browser, go to your GitHub account. The URL should be something like\u00a0www.github.com\/your_username<\/a><\/li>\n\n\n\n
          2. Go into one of your repositories<\/li>\n\n\n\n
          3. Click on Settings<\/strong>, on the upper right part of the page<\/li>\n\n\n\n
          4. Click on Webhooks<\/strong><\/li>\n\n\n\n
          5. Click on Add Webhook<\/strong><\/li>\n\n\n\n
          6. Set the payload url<\/strong> to <http:\/\/your_jenkins_server_url>\/github-webhook\/<\/li>\n\n\n\n
          7. Set Content type<\/strong> to application\/json<\/strong><\/li>\n\n\n\n
          8. Select the event you would like the webhook to be triggered by (I set my webhook to be triggered by \u201cJust the push event\u201d.<\/li>\n\n\n\n
          9. Click on Add webhook<\/strong><\/li>\n<\/ol>\n\n\n\n

            Here\u2019s what those steps look like visually:<\/p>\n\n\n\n

            So, how to get GitHub setup with Jenkins? These steps explain.<\/p>\n\n\n\n

            What you\u2019ll do here is install the Jenkins plugin<\/strong> on your GitHub repository in order to trigger a build in Jenkins when you commit a change in GitHub. This way, Jenkins can run tests to make sure your code is working as expected.<\/p>\n\n\n\n

            On your GitHub account, go to your repository and install the Jenkins plugin:<\/p>\n\n\n\n

              \n
            1. In your browser, go to your GitHub account. The URL should be something like www.github.com\/your_username<\/li>\n\n\n\n
            2. Go into one of your repositories<\/li>\n\n\n\n
            3. Click on Settings<\/strong>, on the upper right part of the page<\/li>\n\n\n\n
            4. Click on Integrations and services<\/strong><\/li>\n\n\n\n
            5. Click on Add service<\/strong><\/li>\n\n\n\n
            6. Search for Jenkins<\/strong><\/li>\n\n\n\n
            7. Add your Jenkins static URL or IP.<\/li>\n\n\n\n
            8. Click on Add service<\/strong><\/li>\n<\/ol>\n\n\n\n

              Here\u2019s what those steps look like visually. <\/p>\n\n\n

              \n
              \"\"<\/figure><\/div>\n\n
              \n
              \"\"<\/figure><\/div>\n\n\n

              Generate a GitHub access token<\/h2>\n\n\n\n

              You will need to generate a GitHub access token for security purposes. This token can be used by an application to use an API, here the application is Jenkins and the API is the GitHub API to update the Jenkins build status in the pull request.<\/p>\n\n\n\n

               Ok, now you\u2019re on to some non-obvious items.<\/p>\n\n\n\n

                \n
              1. Go to your GitHub account.<\/li>\n\n\n\n
              2. Under your profile, open the drop-down menu and click on Settings<\/strong>.<\/li>\n<\/ol>\n\n\n
                \n
                \"\"<\/figure><\/div>\n\n\n

                3. Go to Developer settings<\/strong> on the left side menu, all the way on the bottom:<\/p>\n\n\n

                \n
                \"\"<\/figure><\/div>\n\n\n

                4. Click on Personal access tokens<\/strong>:<\/p>\n\n\n

                \n
                \"\"<\/figure><\/div>\n\n\n

                5. On the top right corner of the screen click on the Generate new token<\/strong> button.<\/p>\n\n\n

                \n
                \"\"<\/figure><\/div>\n\n\n

                6. Insert your password.<\/p>\n\n\n\n

                7. Under repo<\/strong> check the repo:status<\/strong> checkbox.<\/p>\n\n\n

                \n
                \"\"<\/figure><\/div>\n\n\n

                9. Click on Generate token<\/strong> at the bottom of the page.<\/p>\n\n\n

                \n
                \"\"<\/figure><\/div>\n\n\n

                10. Make sure to save your token somewhere so you can use it later, such as in the curl commands above.<\/p>\n\n\n\n

                Jenkins setup<\/h2>\n\n\n\n

                So, how to get Jenkins working with GitHub? Let\u2019s show you how.<\/p>\n\n\n\n

                What you\u2019ll do here is set up your Jenkins project to run your automation tests and call the GitHub API to update the status of the commit with success or failure.<\/p>\n\n\n\n

                Install GitHub plugin:<\/p>\n\n\n\n

                  \n
                1. In your browser, go to your Jenkins URL<\/li>\n\n\n\n
                2. Click on Manage Jenkins<\/strong><\/li>\n\n\n\n
                3. Click on Manage Plugins<\/strong><\/li>\n\n\n\n
                4. Go to Available<\/strong> tab and search for GitHub integration plugin<\/strong><\/li>\n\n\n\n
                5. Check the checkbox on the left and click on download and install after restart<\/strong><\/li>\n<\/ol>\n\n\n\n

                  Setup GitHub configuration:<\/p>\n\n\n\n

                    \n
                  1. Go to your GitHub project<\/li>\n\n\n\n
                  2. Click on Configure<\/li>\n\n\n\n
                  3. On the top bar, click on Source code management<\/li>\n\n\n\n
                  4. Check the Git \u00a0checkbox<\/li>\n\n\n\n
                  5. Paste the repository URL that you would like to integrate with under repository URL.<\/li>\n\n\n\n
                  6. Set the Branch to integrate with under Branch specified.<\/li>\n<\/ol>\n\n\n
                    \n
                    \"\"<\/figure><\/div>\n\n\n

                    Now that you have GitHub setup, do the following:<\/p>\n\n\n\n

                      \n
                    1. In your browser, go to your Jenkins URL<\/li>\n\n\n\n
                    2. Click on Manage Jenkins<\/strong><\/li>\n\n\n\n
                    3. Click on Manage Plugins<\/strong><\/li>\n\n\n\n
                    4. Click on Install <\/strong>Hudson Post Build Task<\/strong><\/li>\n<\/ol>\n\n\n\n

                      Here\u2019s what you\u2019ll see when you run each of those commands. First, the Manage Jenkins command, in the menu bar on the left side:<\/p>\n\n\n

                      \n
                      \"\"<\/figure><\/div>\n\n\n

                      Next, the Manage Plugins command.<\/p>\n\n\n

                      \n
                      \"\"<\/figure><\/div>\n\n\n

                      And finally, the Install Hudson build task command.<\/p>\n\n\n

                      \n
                      \"\"
                      Hudson post-build task<\/figcaption><\/figure><\/div>\n\n\n

                      (In case you\u2019re wondering why you\u2019re installing a Hudson plugin and not a Jenkins plugin, it\u2019s because of this interesting bit of CI historical trivia<\/a>.)<\/p>\n\n\n\n

                      Install Hudson Post Build Task plugin<\/h2>\n\n\n\n

                      The next step is to go into your Jenkins project post build actions<\/a>, and add two post build tasks<\/strong>. One task for success, and another for failure. You will need those actions to distinguish between a successful build and a build that failed.<\/p>\n\n\n\n