I am using Jenkins with GitHub.
My Jenkins is run on a server and polls the GitHub repo all the time for new commits.
When a commit is made, the Jenkins job gets run and I even see the status on GitHub:
However, if I click on Details, it opens the status of the build on Jenkins:
If I want to see why the job failed then I click on "Console Output" on the left
and see the output:
The issue:
I would prefer to be able to see the console output on GitHub itself similarly to how you see the status of a GitHub app (for example in the two images below) like this:
edit: or go to this link and check it for yourself.
Is this possible?
In Azure Devops, in Repos/Pipeline page, there is pipeline status badge(right next to fork and clone buttons)
How is this badge work? I can't find any information about this feature.
Thanks.
This feature is toggled on at the Get Sources page in your build pipeline. Please refer to below pic.
If the Report build status is checked, then the build status will be displayed on source repo.
If unchecked, the build status will stop updating on source repo.(the last status will still be displayed, only not updating )
This seems to be one of the more important, but less understood and documented features of GH and Jenkins, which seems to defeat the purpose of CI entirely ...
I'm trying to setup a simple, "kick off a build when a pull request is opened" Job in Jenkins. I've scanned though dozens of posts, some several years old, but have yet to find a solution that actually works, start-to-finish. I'm using GH 2.15.4 and Jenkins 2.89.3 with the GH Pull Request Builder plug-in. I've tried setting up a pipeline job, and a freestyle project, following various "how to" posts and docs. Nothing works as expected. Not even close. I've managed to get some functionality working, but not without a lot of trial-and-error experimenting, which doesn't leave me with a warm-fuzzy in using it. Webhooks are equally worthless in accomplishing what is needed, as nothing seems to fire off a job in Jenkins, regardless of how it is configured.
For starters, are there any references or docs that explain what the following status checks are that are automatically created by Jenkins:
continuous-integration/jenkins/branch
continuous-integration/jenkins/pr-head
continuous-integration/jenkins/pr-merge
Apparently there is no way to delete or edit these ... they just "appear" courtesy of Jenkins. I've seen some discussions, but some explanations contradict one another, so they may just be outdated, inaccurate, etc. I want to know "what does what" so I know which should be 'required' as part of the PR status check.
Any pointers would be appreciated!
I agree, this problem is tricky because Jenkins and its plugins have changed so much throughout the years. Let me tell you how I accomplished what you're asking for. I will post all of my version numbers (mostly up to date).
Jenkins Version: 2.176.1 (java -jar /usr/share/jenkins/jenkins.war --version)
Plugins
github 1.29.4
github-api 1.9
github-branch-source 2.5.3
github-pullrequest 0.2.5
pipeline-github-lib 1.0
Also, I use the Blue Ocean interface, which might affect things (who knows)
blueocean 1.17.0
blueocean-git-pipeline 1.17.0
blueocean-github-pipeline 1.17.0
Github Webhooks
First off, set up webhooks for your system. This is a good guide for Github Webhooks
Go to your Github repository and click on the Settings tab. Then select 'Webhooks' in the left menu:
The URL of my Jenkins setup is https://jenkinsci.dorian.com. So, in the 'Payload URL' box, I put https://jenkinsci.dorian.com/github-webhook/
I left the settings as "application/json" and "send me everything" and "active"
The Webhooks area has a handy 'Recent Deliveries' section which can show you if your webhooks are making it to Jenkins. At first, I had the wrong URL so mine has red Xs next to them. Now, they're all green checkmarks.
Github Access Token
Many guides suggest that you provide Jenkins with a personal access token to communicate with your repo. To do that, go to your account avatar in the top right and select Settings -> Developer Settings -> Personal access tokens->Generate Token
Put whatever you want for the description. Under 'select scopes', if you just want it to work, select every checkbox in the list.
I selected:
repo:status
write:repo_hook
read:repo_hook
admin:org_hook
Click save and you'll be shown your secret key. Copy this somewhere safe (we'll use it soon).
Configuring Jenkins
Now for the hard part. Try and install all of the plugins I've listed above.
Go to Jenkins-Manage Jenkins->Configure System
Locate the Github section and click Add Github Server
Name: Github
Api URL: https://api.github.com
Manage Hooks: true
Under credentials, click "Add." You'll be brought to a menu. Select "Secret Text"
Scope: Global
Secret: paste your access token from earlier
ID: (I left this blank)
Description: DorianGithubCreds
Hit save. Then, select DorianGithubCreds from the credentials list.
To test, hit "Test Connection." Mine returns 'Credentials verified for user dnrahamim', rate limit: 4998
Now go down to Github Pull Request Builder
GitHub Server API URL: https://api.github.com
Jenkins URL override: (blank)
Shared Secret: (blank)
Credentials: DorianGithubCreds
Auto-manage webhooks: true
Everything else is blank
Configure Job
Go to the job that should be building your repo
Select 'Configure' in the left menu
Under Projects->Github Organization
Credentials: DorianGithubCreds
Owner: Dorian
Behaviors:
Discover branches
Strategy: Exclude branches that are also filed as PRs
Discover pull requests from origin
Strategy: Merging the pull request with the current target branch revision
Discover pull requests from forks
Strategy: Merging the pull request with the current target branch revision
Trust: From users with Admin or Write permission
Project Recognizers
Pipeline Jenkinsfile
Path: Jenkinsfile (my Jenkinsfile is in the project root)
Build Strategies: (intentionally blank)
Notifications
Now, when I do a pull request, or whenever I post a change to a pull request, Jenkins run a fresh build for that branch.
The Pull Request itself in Github also lists its "Status Checks" at the bottom. When the build is pending, the status check is yellow. If it succeeds it gets a green checkmark. If it fails, it gets a red X.
I initially had a problem because I had an old Jenkins box which was also configured to manage Github webhooks and build pull requests. Its builds were failing so its notifications were the ones getting through to my pull request. I fixed that problem by preventing that old Jenkins box from building my newest branches. Once the old Jenkins box stopped building, the notifications from the new Jenkins box made it through to Github.
Wrapping up
That's it! That's everything I intentionally configured. Please try out my configuration and see if it works for you. Let me know if I left anything out.
The hard part with configuring Jenkins with Github is that, although there are many guides, the suggestions often conflict with each other and very many are out of date (sometimes even official documentation is out of date).
Nonetheless, here are some Resources:
This is a good guide for Github Webhooks
Github's Whitepaper on CI with Jenkins (It doesn't explain much in detail but it gives a good overview)
Github pull request builder plugin
Semi-official SO post for showing build status on Github repo
GitHub has "add webhook" feature which is accessible in the repository settings --> Webhooks section. This has 4 inputs
1. Payload URl - Enter the Jenkins url
2. Content Type - application/json
3. Secret - this is optional if you want to configure secret
4. Which events would you like to trigger this webhook? - select the option "Let me select individual events"
Bunch of checkbox options are visible, check "Pull requests" option. This option will send a request to Jenkins when Pull request is opened
Next step is create a job in Jenkins which will listen to GitHub events and kick off the build
It seems that some updates made in the last two weeks to Jenkins plugins or GitHub api introduce a very strange behaviour on GitHub.
Now we can prevent a PR from being merged if a specific Jenkins branch-job is not green but somehow it seems impossible to check if current PR is green.
If we do not select any branch in github repository configuration Jenkins build will not happen and the user would be able to merge the change.
If we check one of them Jenkins will build it and as a surprise we can see the job name that is matching the PR name. Wonderful, but somehow it seems that the generic check named "Jenkins" is still waiting for another status check, one that will never happen, preventing us from merging.
The last screenshot explains it the best: the named merge is green as expected but we also have another generic one "Jenkins" which is still "Waiting for status to be reported" but nothing is to be reported by Jenkins.
You must set Diplay Name for Github plugin, when it doesn't set, plugin fallbacks to build name.
I didn't find correct way to do this when we use Github Organization plugin with pipeline. And I implemented this by setting project properties from Jenkinsfile:
properties properties: [pipelineTriggers([]), [$class: 'GithubProjectProperty', displayName: 'Jenkins']]
And then set status manually:
step([$class: 'GitHubCommitStatusSetter', statusResultSource: [$class: 'ConditionalStatusResultSource', results: [[$class: 'BetterThanOrEqualBuildResult', message: 'Build success', result: 'SUCCESS', state: 'SUCCESS']]]])
This doesn't remove Jenkins job PR-xxxx status, but it adds Jenkins status wich you can use as required check
I try to represent Teamcity build status of project on its Github README.md page.
For this purpose I use TeamCity rest API that exposes status icon at URL
<teamcity-root>/app/rest/builds/buildType:%28id:<buildTypeID>%29/statusIcon
For now I have two Github projects and three TeamCity builds for them (separate builds for two branches).
For all three builds URL built by scheme mentioned above gives me expected image. But Github website replaces original image paths from my TeamCity by own paths from github-camo.global.ssl.fastly.net host. And for two from three builds instead of image I expect to see (success or fail) I get image stating 'No permission to get data'. (It doesn't depend on way I insert image into file: with markdown syntax or inline HTML)
Both Github projects are private. TeamCity site requires login in general but status icons don't.
I've checked also that this situation doesn't depend on TeamCity service hook usage.
I'll be glad to hear any idea on subject.
The settings is in
Project -> Build Configuration Settings -> General Settings -> "enable status widget"
See Teamcity build badge on github
I've found the problem. It was not related to Github. It appears that Status Widget was not enabled for builds in question and in such situation status icon requires login. Enabling the widget solves the problem