GitHub integration with Jenkins

Question

There are multiple approaches in integrating Jenkins with GitHub

Approach 1) Enable ssh communication between GitHub and Jenkins by copying public key file generated in Jenkins to GitHub account. This is one time task.

For any pipeline take any GitHub url(say ssh://git@github.com/account/repo.git) and add using Github plugin for that respective pipeline cocnfiguration

So, Jenkins file just need to have checkout SCM to checkout

Approach 2) Enable https communication by adding webhook for every new repo by generating token and enable https comunication between GitHub and Jenkins. But this approach should be repeated for every new repo created in GitHub.

We are using GitHub repo... in production

Which is the best practice of GitHub integration with Jenkins in production?

score 1 · Answer 1 · answered Nov 24 '19 at 17:28

Unless you are talking about an on-premise GitHub Enterprise, you also have an alternative approach with GitHub Action.

Either by using the built-in CI/CD, which does include an embedded Jenkins Single-shot (slide 42).

Or with appleboy/jenkins-action, a GitHub Action that trigger Jenkins jobs.
That way, you call your own Jenkins server, but without having to declare a webhook and implement a listener for said webhook.

That is:

name: trigger jenkins job
on: [push]
jobs:

  build:
    name: Build
    runs-on: ubuntu-latest
    steps:
    - name: trigger single Job
      uses: appleboy/jenkins-action@master
      with:
        url: "http://example.com"
        user: "example"
        token: ${{ secrets.TOKEN }}
        job: "foobar"

Some teams are maintain ing private repo in GitHub and some Enterprise license — overexchange, Nov 24 '19 at 21:39

score 1 · Accepted Answer · answered Nov 25 '19 at 00:17

1

Both are basically two different things.

The first approach lets you set up credentials to checkout and push source code to GitHub using Jenkins. The second approach lets you set up automated build triggers when a change is detected in the repository.

In summary, the first is mandatory for a build to get the source code, while the second is optional as you can trigger builds manually as well, although automated triggers on code push are inherent to continuous integration. Also, you need not add webhooks individually for every repository. Rather, add it once at the organization level to have all the repositories in that organization covered including any new additions.

answered Nov 25 '19 at 00:17

Dibakar Aditya

3,893
1
14
25

I think you're right.. but second approach need webhook configuration for every repo. Isn't it? – overexchange Nov 25 '19 at 02:43
Can webhook trigger be enabled automatically for any new repo added? In GitHub... – overexchange Nov 25 '19 at 02:52
@overexchange Yes, if you add the webhook at the organization level (under https://github.com/[organization] > **Settings** > **Hooks**), all existing repositories and new repositories added to the organization in future will automatically get covered by GitHub for webhook deliveries. – Dibakar Aditya Nov 25 '19 at 05:08
I haven't worked with Gitlab so far, so won't be able to comment on this part. Sorry for that. – Dibakar Aditya Nov 25 '19 at 05:29

GitHub integration with Jenkins

2 Answers2

Linked