forked from badges/shields
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathgitlab-release.service.js
More file actions
136 lines (123 loc) · 3.44 KB
/
Copy pathgitlab-release.service.js
File metadata and controls
136 lines (123 loc) · 3.44 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
import Joi from 'joi'
import { optionalUrl } from '../validators.js'
import { latest, renderVersionBadge } from '../version.js'
import { NotFound } from '../index.js'
import GitLabBase from './gitlab-base.js'
const schema = Joi.array().items(
Joi.object({
name: Joi.string().required(),
tag_name: Joi.string().required(),
})
)
const queryParamSchema = Joi.object({
gitlab_url: optionalUrl,
include_prereleases: Joi.equal(''),
sort: Joi.string().valid('date', 'semver').default('date'),
display_name: Joi.string().valid('tag', 'release').default('tag'),
}).required()
const namedParams = {
user: 'shields-ops-group',
repo: 'repo-test',
}
export default class GitLabRelease extends GitLabBase {
static category = 'version'
static route = {
base: 'gitlab/v/release',
pattern: ':user/:repo',
queryParamSchema,
}
static examples = [
{
title: 'GitLab Release (latest by date)',
namedParams,
queryParams: { sort: 'date' },
staticPreview: renderVersionBadge({ version: 'v2.0.0' }),
},
{
title: 'GitLab Release (latest by SemVer)',
namedParams,
queryParams: { sort: 'semver' },
staticPreview: renderVersionBadge({ version: 'v4.0.0' }),
},
{
title: 'GitLab Release (latest by SemVer pre-release)',
namedParams,
queryParams: {
sort: 'semver',
include_prereleases: null,
},
staticPreview: renderVersionBadge({ version: 'v5.0.0-beta.1' }),
},
{
title: 'GitLab Release (custom instance)',
namedParams: {
user: 'GNOME',
repo: 'librsvg',
},
queryParams: {
sort: 'semver',
include_prereleases: null,
gitlab_url: 'https://gitlab.gnome.org',
},
staticPreview: renderVersionBadge({ version: 'v2.51.4' }),
},
{
title: 'GitLab Release (by release name)',
namedParams: {
user: 'gitlab-org',
repo: 'gitlab',
},
queryParams: {
sort: 'semver',
include_prereleases: null,
gitlab_url: 'https://gitlab.com',
display_name: 'release',
},
staticPreview: renderVersionBadge({ version: 'GitLab 14.2' }),
},
]
static defaultBadgeData = { label: 'release' }
async fetch({ user, repo, baseUrl, isSemver }) {
// https://docs.gitlab.com/ee/api/releases/
return this.fetchPaginatedArrayData({
schema,
url: `${baseUrl}/api/v4/projects/${user}%2F${repo}/releases`,
errorMessages: {
404: 'project not found',
},
firstPageOnly: !isSemver,
})
}
static transform({ releases, isSemver, includePrereleases, displayName }) {
if (releases.length === 0) {
throw new NotFound({ prettyMessage: 'no releases found' })
}
const displayKey = displayName === 'tag' ? 'tag_name' : 'name'
if (!isSemver) {
return releases[0][displayKey]
}
return latest(
releases.map(t => t[displayKey]),
{ pre: includePrereleases }
)
}
async handle(
{ user, repo },
{
gitlab_url: baseUrl = 'https://gitlab.com',
include_prereleases: pre,
sort,
display_name: displayName,
}
) {
const isSemver = sort === 'semver'
const releases = await this.fetch({ user, repo, baseUrl, isSemver })
const version = this.constructor.transform({
releases,
isSemver,
includePrereleases: pre !== undefined,
displayName,
})
return renderVersionBadge({ version })
}
}