02ec19fd22
The term “url” is overloaded in services, to refer to the Shields route and also the API URL. Calling the Shields URL a “route” is on the whole more descriptive, and makes it clearer and more obvious which one of these we’re talking about. It’s a small thing, though seems like an improvement. We have a few functions called `buildUrl`. I’ve renamed them to `buildRoute` when they refer to routes, and left them as `buildUrl` when they refer to API URLs. I included a minor style tweak and some formatting cleanup in `TUTORIAL.md`.
71 lines
2.2 KiB
JavaScript
71 lines
2.2 KiB
JavaScript
'use strict'
|
|
|
|
const BaseSvgService = require('../base-svg-scraping')
|
|
const { fetch, render } = require('./azure-devops-helpers')
|
|
|
|
const documentation = `
|
|
<p>
|
|
To obtain your own badge, you need to get 4 pieces of information:
|
|
<code>ORGANIZATION</code>, <code>PROJECT_ID</code>, <code>DEFINITION_ID</code> and <code>ENVIRONMENT_ID</code>.
|
|
</p>
|
|
<p>
|
|
First, you need to enable badges for each required environments in the options of your release definition.
|
|
Once you have save the change, look at badge url:
|
|
</p>
|
|
<img
|
|
src="https://user-images.githubusercontent.com/3749820/47266694-7f939d00-d53a-11e8-9224-c2371dd2d0c9.png"
|
|
alt="ORGANIZATION is after the dev.azure.com part, PROJECT_ID is after the badge part, DEFINITION_ID and ENVIRONMENT_ID are right after that." />
|
|
<p>
|
|
Your badge will then have the form:
|
|
<code>https://img.shields.io/vso/release/ORGANIZATION/PROJECT_ID/DEFINITION_ID/ENVIRONMENT_ID.svg</code>.
|
|
</p>
|
|
`
|
|
|
|
module.exports = class AzureDevOpsRelease extends BaseSvgService {
|
|
static get category() {
|
|
return 'build'
|
|
}
|
|
|
|
static get route() {
|
|
return {
|
|
base: '',
|
|
format: '(?:azure-devops|vso)/release/([^/]+)/([^/]+)/([^/]+)/([^/]+)',
|
|
capture: ['organization', 'projectId', 'definitionId', 'environmentId'],
|
|
}
|
|
}
|
|
|
|
static get examples() {
|
|
return [
|
|
{
|
|
title: 'Azure DevOps releases',
|
|
urlPattern:
|
|
'azure-devops/release/:organization/:projectId/:definitionId/:environmentId',
|
|
staticExample: render({ status: 'succeeded' }),
|
|
exampleUrl:
|
|
'azure-devops/release/totodem/8cf3ec0e-d0c2-4fcd-8206-ad204f254a96/1/1',
|
|
keywords: ['vso'],
|
|
documentation,
|
|
},
|
|
]
|
|
}
|
|
|
|
static get defaultBadgeData() {
|
|
return {
|
|
label: 'deployment',
|
|
}
|
|
}
|
|
|
|
async handle({ organization, projectId, definitionId, environmentId }) {
|
|
// Microsoft documentation: ?
|
|
const props = await fetch(this, {
|
|
url: `https://vsrm.dev.azure.com/${organization}/_apis/public/Release/badge/${projectId}/${definitionId}/${environmentId}`,
|
|
errorMessages: {
|
|
400: 'project not found',
|
|
404: 'user or environment not found',
|
|
500: 'inaccessible or definition not found',
|
|
},
|
|
})
|
|
return render(props)
|
|
}
|
|
}
|