14892e3943
* allow serviceData to override cacheSeconds with a longer value * prevent [endpoint] json cacheSeconds property exceeding service default * allow ShieldsRuntimeError to specify a cacheSeconds property By default error responses use the cacheLength of the service class throwing the error. This allows error to tell the handling layer the maxAge that should be set on the error badge response. * add customExceptions param This 1. allows us to specify custom properties to pass to the exception constructor if we throw any of the standard got errors e.g: `ETIMEDOUT`, `ECONNRESET`, etc 2. uses a custom `cacheSeconds` property (if set on the exception) to set the response maxAge * customExceptions --> systemErrors * errorMessages --> httpErrors
101 lines
2.5 KiB
JavaScript
101 lines
2.5 KiB
JavaScript
import Joi from 'joi'
|
|
import { isBuildStatus, renderBuildStatusBadge } from '../build-status.js'
|
|
import { BaseSvgScrapingService } from '../index.js'
|
|
import { documentation } from './github-helpers.js'
|
|
|
|
const schema = Joi.object({
|
|
message: Joi.alternatives()
|
|
.try(isBuildStatus, Joi.equal('no status'))
|
|
.required(),
|
|
}).required()
|
|
|
|
const queryParamSchema = Joi.object({
|
|
event: Joi.string(),
|
|
branch: Joi.alternatives().try(Joi.string(), Joi.number().cast('string')),
|
|
}).required()
|
|
|
|
const keywords = ['action', 'actions']
|
|
|
|
export default class GithubActionsWorkflowStatus extends BaseSvgScrapingService {
|
|
static category = 'build'
|
|
|
|
static route = {
|
|
base: 'github/actions/workflow/status',
|
|
pattern: ':user/:repo/:workflow+',
|
|
queryParamSchema,
|
|
}
|
|
|
|
static examples = [
|
|
{
|
|
title: 'GitHub Workflow Status',
|
|
namedParams: {
|
|
user: 'actions',
|
|
repo: 'toolkit',
|
|
workflow: 'unit-tests.yml',
|
|
},
|
|
staticPreview: renderBuildStatusBadge({
|
|
status: 'passing',
|
|
}),
|
|
documentation,
|
|
keywords,
|
|
},
|
|
{
|
|
title: 'GitHub Workflow Status (with branch)',
|
|
namedParams: {
|
|
user: 'actions',
|
|
repo: 'toolkit',
|
|
workflow: 'unit-tests.yml',
|
|
},
|
|
queryParams: {
|
|
branch: 'main',
|
|
},
|
|
staticPreview: renderBuildStatusBadge({
|
|
status: 'passing',
|
|
}),
|
|
documentation,
|
|
keywords,
|
|
},
|
|
{
|
|
title: 'GitHub Workflow Status (with event)',
|
|
namedParams: {
|
|
user: 'actions',
|
|
repo: 'toolkit',
|
|
workflow: 'unit-tests.yml',
|
|
},
|
|
queryParams: {
|
|
event: 'push',
|
|
},
|
|
staticPreview: renderBuildStatusBadge({
|
|
status: 'passing',
|
|
}),
|
|
documentation,
|
|
keywords,
|
|
},
|
|
]
|
|
|
|
static defaultBadgeData = {
|
|
label: 'build',
|
|
}
|
|
|
|
async fetch({ user, repo, workflow, branch, event }) {
|
|
const { message: status } = await this._requestSvg({
|
|
schema,
|
|
url: `https://github.com/${user}/${repo}/actions/workflows/${encodeURIComponent(
|
|
workflow
|
|
)}/badge.svg`,
|
|
options: { searchParams: { branch, event } },
|
|
valueMatcher: />([^<>]+)<\/tspan><\/text><\/g><path/,
|
|
httpErrors: {
|
|
404: 'repo or workflow not found',
|
|
},
|
|
})
|
|
|
|
return { status }
|
|
}
|
|
|
|
async handle({ user, repo, workflow }, { branch, event }) {
|
|
const { status } = await this.fetch({ user, repo, workflow, branch, event })
|
|
return renderBuildStatusBadge({ status })
|
|
}
|
|
}
|