mirror of
https://github.com/badges/shields.git
synced 2025-11-27 06:21:18 +03:00
100 lines
2.6 KiB
JavaScript
100 lines
2.6 KiB
JavaScript
import Joi from 'joi'
|
|
import { age as ageColor } from '../color-formatters.js'
|
|
import { NotFound, pathParam, queryParam } from '../index.js'
|
|
import { formatDate } from '../text-formatters.js'
|
|
import { optionalUrl, relativeUri } from '../validators.js'
|
|
import GitLabBase from './gitlab-base.js'
|
|
import { description, httpErrorsFor } from './gitlab-helper.js'
|
|
|
|
const schema = Joi.array()
|
|
.items(
|
|
Joi.object({
|
|
committed_date: Joi.string().required(),
|
|
}),
|
|
)
|
|
.required()
|
|
|
|
const queryParamSchema = Joi.object({
|
|
ref: Joi.string(),
|
|
gitlab_url: optionalUrl,
|
|
path: relativeUri,
|
|
}).required()
|
|
|
|
const refText = `
|
|
ref can be filled with the name of a branch, tag or revision range of the repository.
|
|
`
|
|
|
|
const lastCommitDescription = description + refText
|
|
|
|
export default class GitlabLastCommit extends GitLabBase {
|
|
static category = 'activity'
|
|
|
|
static route = {
|
|
base: 'gitlab/last-commit',
|
|
pattern: ':project+',
|
|
queryParamSchema,
|
|
}
|
|
|
|
static openApi = {
|
|
'/gitlab/last-commit/{project}': {
|
|
get: {
|
|
summary: 'GitLab Last Commit',
|
|
description: lastCommitDescription,
|
|
parameters: [
|
|
pathParam({
|
|
name: 'project',
|
|
example: 'gitlab-org/gitlab',
|
|
}),
|
|
queryParam({
|
|
name: 'gitlab_url',
|
|
example: 'https://gitlab.com',
|
|
}),
|
|
queryParam({
|
|
name: 'ref',
|
|
example: 'master',
|
|
}),
|
|
queryParam({
|
|
name: 'path',
|
|
example: 'README.md',
|
|
schema: { type: 'string' },
|
|
description: 'File path to resolve the last commit for.',
|
|
}),
|
|
],
|
|
},
|
|
},
|
|
}
|
|
|
|
static defaultBadgeData = { label: 'last commit' }
|
|
|
|
static render({ commitDate }) {
|
|
return {
|
|
message: formatDate(commitDate),
|
|
color: ageColor(Date.parse(commitDate)),
|
|
}
|
|
}
|
|
|
|
async fetch({ project, baseUrl, ref, path }) {
|
|
// https://docs.gitlab.com/ee/api/commits.html#list-repository-commits
|
|
return super.fetch({
|
|
url: `${baseUrl}/api/v4/projects/${encodeURIComponent(
|
|
project,
|
|
)}/repository/commits`,
|
|
options: { searchParams: { ref_name: ref, path, per_page: 1 } },
|
|
schema,
|
|
httpErrors: httpErrorsFor('project not found'),
|
|
})
|
|
}
|
|
|
|
async handle(
|
|
{ project },
|
|
{ gitlab_url: baseUrl = 'https://gitlab.com', ref, path },
|
|
) {
|
|
const data = await this.fetch({ project, baseUrl, ref, path })
|
|
const [commit] = data
|
|
|
|
if (!commit) throw new NotFound({ prettyMessage: 'no commits found' })
|
|
|
|
return this.constructor.render({ commitDate: commit.committed_date })
|
|
}
|
|
}
|