Paul MelnikowandGitHub
3ad742e79a
Close #2334 To avoid merge conflicts, I've deferred removing the aliasing logic in `prepareExamples`. That whole function will be refactored momentarily, and there's also #2339 open.
90 lines
3.1 KiB
JavaScript
90 lines
3.1 KiB
JavaScript
'use strict'
|
|
|
|
const BaseSvgService = require('../base-svg-scraping')
|
|
const { NotFound } = require('../errors')
|
|
const { fetch, render } = require('./azure-devops-helpers')
|
|
|
|
const documentation = `
|
|
<p>
|
|
To obtain your own badge, you need to get 3 pieces of information:
|
|
<code>ORGANIZATION</code>, <code>PROJECT_ID</code> and <code>DEFINITION_ID</code>.
|
|
</p>
|
|
<p>
|
|
First, you need to edit your build definition and look at the url:
|
|
</p>
|
|
<img
|
|
src="https://user-images.githubusercontent.com/3749820/47259976-e2d9ec80-d4b2-11e8-92cc-7c81089a7a2c.png"
|
|
alt="ORGANIZATION is after the dev.azure.com part, PROJECT_NAME is right after that, DEFINITION_ID is at the end after the id= part." />
|
|
<p>
|
|
Then, you can get the <code>PROJECT_ID</code> from the <code>PROJECT_NAME</code> using Azure DevOps REST API.
|
|
Just access to: <code>https://dev.azure.com/ORGANIZATION/_apis/projects/PROJECT_NAME</code>.
|
|
</p>
|
|
<img
|
|
src="https://user-images.githubusercontent.com/3749820/47266325-1d846900-d535-11e8-9211-2ee72fb91877.png"
|
|
alt="PROJECT_ID is in the id property of the API response." />
|
|
<p>
|
|
Your badge will then have the form:
|
|
<code>https://img.shields.io/vso/build/ORGANIZATION/PROJECT_ID/DEFINITION_ID.svg</code>.
|
|
</p>
|
|
<p>
|
|
Optionally, you can specify a named branch:
|
|
<code>https://img.shields.io/vso/build/ORGANIZATION/PROJECT_ID/DEFINITION_ID/NAMED_BRANCH.svg</code>.
|
|
</p>
|
|
`
|
|
|
|
module.exports = class AzureDevOpsBuild extends BaseSvgService {
|
|
static get category() {
|
|
return 'build'
|
|
}
|
|
|
|
static get route() {
|
|
return {
|
|
base: '',
|
|
format: '(?:azure-devops|vso)/build/([^/]+)/([^/]+)/([^/]+)(?:/(.+))?',
|
|
capture: ['organization', 'projectId', 'definitionId', 'branch'],
|
|
}
|
|
}
|
|
|
|
static get examples() {
|
|
return [
|
|
{
|
|
title: 'Azure DevOps builds',
|
|
pattern: 'azure-devops/build/:organization/:projectId/:definitionId',
|
|
staticExample: render({ status: 'succeeded' }),
|
|
exampleUrl:
|
|
'azure-devops/build/totodem/8cf3ec0e-d0c2-4fcd-8206-ad204f254a96/2',
|
|
keywords: ['vso'],
|
|
documentation,
|
|
},
|
|
{
|
|
title: 'Azure DevOps builds (branch)',
|
|
pattern:
|
|
'azure-devops/build/:organization/:projectId/:definitionId/:branch',
|
|
staticExample: render({ status: 'succeeded' }),
|
|
exampleUrl:
|
|
'azure-devops/build/totodem/8cf3ec0e-d0c2-4fcd-8206-ad204f254a96/2/master',
|
|
keywords: ['vso'],
|
|
documentation,
|
|
},
|
|
]
|
|
}
|
|
|
|
async handle({ organization, projectId, definitionId, branch }) {
|
|
// Microsoft documentation: https://docs.microsoft.com/en-us/rest/api/vsts/build/status/get
|
|
const { status } = await fetch(this, {
|
|
url: `https://dev.azure.com/${organization}/${projectId}/_apis/build/status/${definitionId}`,
|
|
qs: { branchName: branch },
|
|
errorMessages: {
|
|
404: 'user or project not found',
|
|
},
|
|
})
|
|
if (status === 'set up now') {
|
|
throw new NotFound({ prettyMessage: 'definition not found' })
|
|
}
|
|
if (status === 'unknown') {
|
|
throw new NotFound({ prettyMessage: 'project not found' })
|
|
}
|
|
return render({ status })
|
|
}
|
|
}
|