I noticed in some GitHub projects a build status badge in the README.md display. As I have Azure Pipeline builds setup for two of my projects, CSVComparer and SuperMarketPlanner, I thought it would a good idea to add this.
Handily, there is a REST API interface available for the Azure Pipeline build!
The link for the badge is of the form:
https://dev.azure.com/{Organisation}/{Project}/_apis/build/status/{pipelinename}
For CSVComparer that's:
https://dev.azure.com/jonathanscott80/CSVComparer/_apis/build/status/jscott7.CSVComparer
Then I can add a hyperlink to the badge to navigate to the latest build page when clicked. This is of the form:
https://dev.azure.com/{Organisation}/{Project}/_build/latest?definitionId={id}
Again, for CSVComparer that's:
https://dev.azure.com/jonathanscott80/CSVComparer/_build/latest?definitionId=2
The definitionId is the ID of the Pipeline assigned by Azure. You can find this by navigating through to the Pipeline page via https://dev.azure.com/{Organisation}/
(Useful link for the official docs here : Azure Pipelines documentation | Microsoft Docs)
Finally, to put it all together add this to the README.md file:
[](https://dev.azure.com/jonathanscott80/CSVComparer/_build/latest?definitionId=2)
And clicking on the badge takes us here:
No comments:
Post a Comment