GitHub Webhook: Organization Folder

Issue

  • How to make GitHub (and/or GitHub Enterprise) trigger jobs from GitHub Organization Folders in Jenkins.

Environment

Jenkins

Plugins

GitHub

Resolution

On Jenkins

A. Plugin Configuration

GitHub plugin as explained in GitHub Webhook configuration.

For GitHub Branch Source in case you wish to integrate with a GitHub Enterprise, it needs to be added in Manage Jenkins > Configure System > GitHub Enterprise Servers in order to fetch organizations from that endpoint.

GHE-apiEndpoints.png

B. Job Configuration

Steps:

  1. Branch Sources > Add source > GitHub Select the API endpoint
  2. For Owner use the organization
  3. For Credential use Username and Password, typing as password the personal API Token.
  4. Since SCM API 2.2.4 Behaviors section > Make sure Filter by name is removed unless you only want to discover a subset of branches. If it is configured make sure to include PR-* to Discover Pull Requests.

Notes: Automatic branch project triggering > Branch names to build automatically Allows you to control the SCM commit trigger coming from branch indexing.

After saving the job, there is a view with contains all Repositories.

org_views.png

Each of the repositories contains Branches and Pull Request views as explained in [GitHub Webhook Pipeline Multibranch]

On GitHub

C. Validate GitHub WebHook

Make sure post-receive hooks has been created on GitHub at the Organization as follows:

  • <JENKINS_URL>/github-webhook/ for Pull request, Push and Repository events.

GH_webhook_Organzation.png

Troubleshooting

If the post-receive hooks are not there, please review Troubleshooting

References

Tested products/plugins version

The latest update of this article has been tested with:

Was this article helpful?
0 out of 0 found this helpful

Have more questions?

3 Comments

Date Votes
  • 0
    Avatar
    Imran Malik

    is there a init.groovy code to configure these Github Enterprise settings automatically? 

  • 0
    Avatar
    Allan Burdajewicz

    Hello Imran,

    In groovy, you could set the endpoint like the following:

    def githubGlobalConfig = org.jenkinsci.plugins.github_branch_source.GitHubConfiguration.get()
    githubGlobalConfig.get().setEndpoints([
      new org.jenkinsci.plugins.github_branch_source.Endpoint("https://my.github.first.example.com/api/v3", "MyGitHubFirstExample"),
      new org.jenkinsci.plugins.github_branch_source.Endpoint("https://my.github.second.example.com/api/v3", "MyGitHubSecondExample"),
    ])
    githubGlobalConfig.save()

    See org.jenkinsci.plugins.github_branch_source.GitHubConfiguration for more details.

    Regards,

  • 0
    Avatar
    Zacky Azoulay

    Hi

    Is there a way to add "Cancel Build on Update" for "github organization" plugin like in" GitHub Pull Request Builder" plugin

    Thanks Zacky

Please sign in to leave a comment.