I wanted to add a teamcity build badge on my github page.My repository is a private github repository.
I started of by including the code below as the link said.
<a href="http://teamcity/viewType.html?buildTypeId=myID&guest=1">
<img src="http://teamcity/app/rest/builds/buildType(id:myID)/statusIcon"/>
</a>
The problem I got stuck at then,was that the image was being blocked.I suspected that this was because my teamcity server was on http while my github repo used https.
In my case it is not possible to change teamcity to use https and so this was not an option.
Any workarounds/suggestions for how to get my build badges on github?
Make sure to check "enable status widget" checkbox on the General Setting page:
For anyone looking for the markdown link syntax of the TeamCity build badge, here it is:
[/statusIcon)](http://teamcity/viewType.html?buildTypeId=myID&guest=1)
For the user pages displayed, GitHub retrieves the images from the server side and replaces the original image with the one cached. That is why, the TeamCity instance should be accessible externally and the status icon should be available to any user: the easiest way to ensure that is to check "enable status widget" as Boris suggested.
The image is also cached quite aggressively by GitHub, so the badge shown can be outdated. Use at least TeamCity 10.0.2 which has added HTTP headers trying to prevent that caching.
Related
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
I have developed a tiny library that I chose to host on GitHub. The code is being built by a VSTS build and published as a NuGet package.
I have written a README.md file and I am trying to include a Build badge on it, as described in the Microsoft documentation. Consequently, I have added the following line in the MD file and replaced the placeholders accordindly:
The problem is that the link is not accessible to anyone that is not logged-in on VSTS and I end up with a 'broken' link on my readme page:
Question
What must be done to make the VSTS Build Badge available to a GitHub repo?
I suppose you must include an authentication token of sorts in order to have at least read-access to the VSTS build from your GitHub page.
Note that the documentation lists also multiple pending issues, including MicrosoftDocs/vsts-docs issue 1499:
Build status badge added to GitHub readme doesn't show up.
So this is still in progress.
On that last issue, it says:
This is due to public vs. private projects.
If you make your project public the image URL will render.
There are other potential workarounds we are looking at for the doc.
See "Change the project visibility, public or private".
I'm trying to add status icon from Jenkins to GitHub README.md file but the icon doesn't display.
The Embeddable Build Status Icon plugin is installed on Jenkins.
I searched for solutions and found out that I need to change the "configure security" on Jenkins (I activated the Job->ViewStatus checkbox at the "Matrix-based security" for the Anonymous user) but it didn't work.
I tried to add someone else status icon to the README file and it works, so I think the problem is from Jenkins.
The row that I'm trying to add to README is:
The link status icon works, but doesn't display on README
Anyone have any idea how to fix it?
Github caches README images, according to Aggressive image caching breaks image badges #24, so my guess is that either:
Your build icon is not visible to Github's caching proxy, or
Your jenkins status server is not serving correct HTTP caching headers
Here's an example of a project:
https://github.com/storm-enroute/macrogl
The README.md of this project contains a build status image from a Jenkins running on a server somewhere else:
[](https://ci.storm-enroute.com:8080/job/public-macrogl/)
This image is rendered perfectly in Stackoverflow and Github static pages, but on the Github website it is cached to the content delivery network called Fastly. Opening the image URL shows "Not found".
Why is this happening?
How do I have the Github web interface render a markdown with such an image correctly?
How do I have the Github web interface render a markdown with such an image correctly?
The syntax is correct.
Some other project leverage such feature (see LibGit2Sharp Readme or libgit2 Readme for instance).
Why is this happening?
Few seconds ago, https://ci.storm-enroute.com:8080/job/public-macrogl/badge/icon was returning a 404 for me. It looks now fixed.
However, there's a possibility that when the CI server is offline/can't be reached, the 404 is temporarily cached by Camo and served until the cache expires.
install jenkins plugin for embeddable-build-status from: https://plugins.jenkins.io/embeddable-build-status
add to your README.md the tags you want:
Plain Link (with view)
http://URL:8080/buildStatus/icon?job=JOB_NAME
Plain Link (without view)
http://URL:8080/buildStatus/icon?job=JOB_NAME
Markdown (with view)
Build Status http://URL:8080/buildStatus/icon?job=JOB_NAME
Markdown (without view)
Build Status http://URL:8080/buildStatus/icon?job=JOB_NAME
3.Configure jenkins security to allow the status view:
Manage Jenkins -> Configure Security -> Authorization -> choose matrix-based security and check the "ViewStatus" box for the Anonymous user.
if admin user is not there, add it and give it permission to all the boxes.
For anyone else spending way more time than intended on this and wanting a little clarity on what link(s) to use after installing the Emeddable Build Status plugin:
If you navigate to the job in the Jenkins (jenkins_home >> repo >> project >> branch), there's a "Emeddable Build Status" widget you can click on the left pane, and it'll show list exactly what links you can use for your specific jobs.
The following URL structure might also get you to the embeddable build status page:
https://<jenkins_host>/job/<github_owner_or_org>/job/<github_repo_name>/job/master/badge/
Update: I had a similar issue. It turned that the cache server requires the image to be hosted behind a HTTPS, with a fully valid SSL certificate chain (CA(s) + cert). Once your server provides the full cert chain, github will display your badge.
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