forked from badges/shields
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathgithub-tag.service.js
More file actions
164 lines (152 loc) · 4.3 KB
/
Copy pathgithub-tag.service.js
File metadata and controls
164 lines (152 loc) · 4.3 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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
import gql from 'graphql-tag'
import Joi from 'joi'
import { addv } from '../text-formatters.js'
import { version as versionColor } from '../color-formatters.js'
import { latest } from '../version.js'
import { NotFound, redirector } from '../index.js'
import { GithubAuthV4Service } from './github-auth-service.js'
import { queryParamSchema } from './github-common-release.js'
import { documentation, transformErrors } from './github-helpers.js'
const schema = Joi.object({
data: Joi.object({
repository: Joi.object({
refs: Joi.object({
edges: Joi.array()
.items({
node: Joi.object({
name: Joi.string().required(),
}).required(),
})
.required(),
}).required(),
}).required(),
}).required(),
}).required()
class GithubTag extends GithubAuthV4Service {
static category = 'version'
static route = {
base: 'github/v/tag',
pattern: ':user/:repo',
queryParamSchema,
}
static examples = [
{
title: 'GitHub tag (latest by date)',
namedParams: { user: 'expressjs', repo: 'express' },
staticPreview: this.render({
version: 'v5.0.0-alpha.7',
sort: 'date',
}),
documentation,
},
{
title: 'GitHub tag (latest SemVer)',
namedParams: { user: 'expressjs', repo: 'express' },
queryParams: { sort: 'semver' },
staticPreview: this.render({ version: 'v4.16.4', sort: 'semver' }),
documentation,
},
{
title: 'GitHub tag (latest SemVer pre-release)',
namedParams: { user: 'expressjs', repo: 'express' },
queryParams: { sort: 'semver', include_prereleases: null },
staticPreview: this.render({
version: 'v5.0.0-alpha.7',
sort: 'semver',
}),
documentation,
},
]
static defaultBadgeData = {
label: 'tag',
}
static render({ version, sort }) {
return {
message: addv(version),
color: sort === 'semver' ? versionColor(version) : 'blue',
}
}
async fetch({ user, repo, sort }) {
const limit = sort === 'semver' ? 100 : 1
return this._requestGraphql({
query: gql`
query ($user: String!, $repo: String!, $limit: Int!) {
repository(owner: $user, name: $repo) {
refs(
refPrefix: "refs/tags/"
first: $limit
orderBy: { field: TAG_COMMIT_DATE, direction: DESC }
) {
edges {
node {
name
}
}
}
}
}
`,
variables: { user, repo, limit },
schema,
transformErrors,
})
}
static getLatestTag({ tags, sort, includePrereleases }) {
if (sort === 'semver') {
return latest(tags, { pre: includePrereleases })
}
return tags[0]
}
async handle({ user, repo }, queryParams) {
const sort = queryParams.sort
const includePrereleases = queryParams.include_prereleases !== undefined
const json = await this.fetch({ user, repo, sort })
const tags = json.data.repository.refs.edges.map(edge => edge.node.name)
if (tags.length === 0) {
throw new NotFound({ prettyMessage: 'no tags found' })
}
return this.constructor.render({
version: this.constructor.getLatestTag({
tags,
sort,
includePrereleases,
}),
sort,
})
}
}
const redirects = {
GithubTagRedirect: redirector({
category: 'version',
route: {
base: 'github/tag',
pattern: ':user/:repo',
},
transformPath: ({ user, repo }) => `/github/v/tag/${user}/${repo}`,
transformQueryParams: params => ({ sort: 'semver' }),
dateAdded: new Date('2019-08-17'),
}),
GithubTagPreRedirect: redirector({
category: 'version',
route: {
base: 'github/tag-pre',
pattern: ':user/:repo',
},
transformPath: ({ user, repo }) => `/github/v/tag/${user}/${repo}`,
transformQueryParams: params => ({
sort: 'semver',
include_prereleases: null,
}),
dateAdded: new Date('2019-08-17'),
}),
GithubTagDateRedirect: redirector({
category: 'version',
route: {
base: 'github/tag-date',
pattern: ':user/:repo',
},
transformPath: ({ user, repo }) => `/github/v/tag/${user}/${repo}`,
dateAdded: new Date('2019-08-17'),
}),
}
export { GithubTag, redirects }