{"id":1106,"date":"2024-08-20T14:07:17","date_gmt":"2024-08-20T14:07:17","guid":{"rendered":"https:\/\/blog.ngocha.biz\/?p=1106"},"modified":"2024-08-20T14:07:17","modified_gmt":"2024-08-20T14:07:17","slug":"enable-jenkins-status-checks-github","status":"publish","type":"post","link":"https:\/\/blog.ngocha.biz\/?p=1106","title":{"rendered":"How to Create GitHub App For Jenkins Status Checks"},"content":{"rendered":"

When you use Jenkins multi-branch pipelines<\/a>, you can integrate status checks with GitHub Pull Requests.<\/p>\n

Here is an example of status checks.<\/p>\n

<\/figure>\n

To implement these types of status checks, you need to create a GitHub App that integrates with the Jenkins controller instance.<\/p>\n

In this blog, we will look at how to create a GitHub app for enabling status checks in the pipeline.<\/p>\n

Creating Github App<\/h2>\n

To create a GitHub App, select your GitHub profile and go to Settings<\/strong> as shown below.<\/p>\n

<\/figure>\n

Scroll down and select the Developer settings<\/strong><\/p>\n

<\/figure>\n

Then click the New GitHub App<\/strong> button to create a new GitHub app<\/p>\n

<\/figure>\n

You need to fill out the following details in the configurations.<\/p>\n

    \n
  1. GitHub App name:<\/strong> This name has to be unique. For example, jenkins-techiescamp-app. Replace it with the required name.<\/li>\n
  2. Homepage URL:<\/strong> Enter your Jenkins URL.<\/li>\n
  3. Webhook URL:<\/strong> Jenkins URLs with the webhook path (http:\/\/64.227.177.136:30000\/github-webhook\/)<\/li>\n<\/ol>\n
    <\/figure>\n

    Under Repository permissions<\/strong>, choose the following permissions from the drop-down menu.<\/p>\n

      \n
    1. Administration:<\/strong> Read-only<\/li>\n
    2. Checks:<\/strong> Read & write<\/li>\n
    3. Commit statuses<\/strong>: Read & write<\/li>\n
    4. Contents:<\/strong> Read-only (to read the Jenkinsfile<\/code> and the repository content during git fetch<\/code>).<\/li>\n
    5. Metadata:<\/strong> Read-only<\/li>\n
    6. Pull requests:<\/strong> Read-only<\/li>\n<\/ol>\n
      <\/figure>\n

      Under Subscribe to events<\/strong>, select the following events:<\/p>\n

        \n
      1. Check run<\/li>\n
      2. Check suite<\/li>\n
      3. Pull request<\/li>\n
      4. Push<\/li>\n
      5. Repository<\/li>\n<\/ol>\n
        <\/figure>\n

        Now, click the Create Github app<\/strong> button.<\/p>\n

        <\/figure>\n

        After creating the app, you will see a notification to generate the private key as shown below.<\/p>\n

        <\/figure>\n

        Click on the generate the private key<\/strong> option and click Generate a private key<\/strong> button as given below.<\/p>\n

        <\/figure>\n

        It will download a private key.<\/p>\n

        Now, you need to convert the key to a format that can be used with Jenkins using the following command. Replace key-in-your-downloads-folder.pem<\/code><\/strong> with your downloaded private key.<\/p>\n

        openssl pkcs8 -topk8 -inform PEM -outform PEM -in key-in-your-downloads-folder.pem -out converted-github-app.pem -nocrypt<\/code><\/pre>\n
        We need to add the converted key to Jenkins credentials.<\/p>\n
        Install Github App<\/h2>\n
        Now, on the app configuration page, you will see an option called Install app<\/strong>, as given below. Click that option to enable this app for all the repositories.<\/p>\n
        <\/figure>\n
        Click Install<\/strong><\/p>\n
        <\/figure>\n
        You can choose all or individual repositories you need and then click Install.<\/p>\n
        <\/figure>\n
        Add Private Key to Jenkins Credentials<\/h2>\n
        Now, we need to add the converted PEM key to the Jenkins credentials.<\/p>\n
        Go to Jenkins Home –> manage jenkins –> Credentials<\/strong>.<\/p>\n
        <\/figure>\n
        Under credentials, select the global<\/strong> option<\/p>\n
        <\/figure>\n
        Then, choose the Add Credentials<\/strong> Option to add a new credential<\/span><\/p>\n
        .<\/p>\n
        <\/figure>\n
        Now you need to choose the Kind as GitHub App.<\/p>\n
        Also we need the Github App ID<\/strong>. You can get it from the Github App configuration as shown below.<\/p>\n
        <\/figure>\n
        In the key field, add the converted-github-app.pem<\/strong> private file contents we converted before, and then click the Create<\/strong> button as shown below.<\/p>\n
        <\/figure>\n
        That’s pretty much it.<\/p>\n
        Now, you can use this credential in the multi-branch pipeline to enable checks during PR.<\/p>\n
        \n
        Ngu\u1ed3n:<\/strong> How to Create GitHub App For Jenkins Status Checks \u2014 DevOpsCube<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
        Source: https:\/\/devopscube.com\/enable-jenkins-status-checks-github\/<\/p>\n","protected":false},"author":1,"featured_media":1107,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-1106","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-devops"],"_links":{"self":[{"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/posts\/1106","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=1106"}],"version-history":[{"count":0,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/posts\/1106\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/media\/1107"}],"wp:attachment":[{"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1106"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=1106"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=1106"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}