Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow [GitHub] tag badge to sort by date #2157

Merged
merged 5 commits into from
Oct 8, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions lib/all-badge-examples.js
Original file line number Diff line number Diff line change
Expand Up @@ -1242,10 +1242,20 @@ const allBadgeExamples = [
previewUrl: '/hexpm/v/plug.svg',
},
{
title: 'GitHub tag',
title: 'GitHub tag (latest SemVer)',
previewUrl: '/github/tag/expressjs/express.svg',
documentation: githubDoc,
},
{
title: 'GitHub tag (latest SemVer pre-release)',
previewUrl: '/github/tag-pre/expressjs/express.svg',
documentation: githubDoc,
},
{
title: 'GitHub tag (latest by date)',
previewUrl: '/github/tag-date/expressjs/express.svg',
documentation: githubDoc,
},
{
title: 'GitHub package version',
previewUrl: '/github/package-json/v/badges/shields.svg',
Expand All @@ -1263,7 +1273,7 @@ const allBadgeExamples = [
},
{
title: 'GitHub (pre-)release',
previewUrl: '/github/release/qubyte/rubidium/all.svg',
previewUrl: '/github/release-pre/qubyte/rubidium.svg',
documentation: githubDoc,
},
{
Expand Down
6 changes: 5 additions & 1 deletion services/github/github-license.service.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,11 @@ module.exports = class GithubLicense extends LegacyService {
const body = JSON.parse(buffer)
const license = body.license
if (license != null) {
badgeData.text[1] = license.spdx_id || 'unknown'
if (!license.spdx_id || license.spdx_id === 'NOASSERTION') {
badgeData.text[1] = 'unknown'
} else {
badgeData.text[1] = license.spdx_id
}
setBadgeColor(badgeData, licenseToColor(license.spdx_id))
sendBadge(format, badgeData)
} else {
Expand Down
12 changes: 6 additions & 6 deletions services/github/github-release.service.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ const {
module.exports = class GithubRelease extends LegacyService {
static registerLegacyRouteHandler({ camp, cache, githubApiProvider }) {
camp.route(
/^\/github\/release\/([^/]+\/[^/]+)(?:\/(all))?\.(svg|png|gif|jpg|json)$/,
/^\/github\/release(-pre)?\/([^/]+\/[^/]+)(?:\/(all))?\.(svg|png|gif|jpg|json)$/,
cache((data, match, sendBadge, request) => {
const userRepo = match[1] // eg, qubyte/rubidium
const allReleases = match[2]
const format = match[3]
const includePre = Boolean(match[1]) || match[3] === 'all'
const userRepo = match[2] // eg, qubyte/rubidium
const format = match[4]
let apiUrl = `/repos/${userRepo}/releases`
if (allReleases === undefined) {
if (!includePre) {
apiUrl = apiUrl + '/latest'
}
const badgeData = getBadgeData('release', data)
Expand All @@ -33,7 +33,7 @@ module.exports = class GithubRelease extends LegacyService {
}
try {
let data = JSON.parse(buffer)
if (allReleases === 'all') {
if (includePre) {
data = data[0]
}
const version = data.tag_name
Expand Down
13 changes: 9 additions & 4 deletions services/github/github-tag.service.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,10 @@ const {
module.exports = class GithubTag extends LegacyService {
static registerLegacyRouteHandler({ camp, cache, githubApiProvider }) {
camp.route(
/^\/github\/tag(-?pre)?\/([^/]+)\/([^/]+)\.(svg|png|gif|jpg|json)$/,
/^\/github\/(tag-pre|tag-date|tag)\/([^/]+)\/([^/]+)\.(svg|png|gif|jpg|json)$/,
cache((data, match, sendBadge, request) => {
const includePre = Boolean(match[1])
const includePre = match[1].includes('pre')
const sortOrder = match[1] === 'tag-date' ? 'date' : 'semver'
const user = match[2] // eg, expressjs/express
const repo = match[3]
const format = match[4]
Expand All @@ -34,9 +35,13 @@ module.exports = class GithubTag extends LegacyService {
try {
const data = JSON.parse(buffer)
const versions = data.map(e => e.name)
const tag = latestVersion(versions, { pre: includePre })
const tag =
sortOrder === 'date'
? versions[0]
: latestVersion(versions, { pre: includePre })
badgeData.text[1] = versionText(tag)
badgeData.colorscheme = versionColor(tag)
badgeData.colorscheme =
sortOrder === 'date' ? 'blue' : versionColor(tag)
sendBadge(format, badgeData)
} catch (e) {
badgeData.text[1] = 'none'
Expand Down
41 changes: 41 additions & 0 deletions services/github/github.tester.js
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,10 @@ t.create('Release (repo not found)')
.expectJSON({ name: 'release', value: 'repo not found' })

t.create('(pre-)Release')
.get('/release-pre/photonstorm/phaser.json')
.expectJSONTypes(Joi.object().keys({ name: 'release', value: Joi.string() }))

t.create('(pre-)Release (for legacy compatibility)')
.get('/release/photonstorm/phaser/all.json')
.expectJSONTypes(Joi.object().keys({ name: 'release', value: Joi.string() }))

Expand Down Expand Up @@ -402,10 +406,47 @@ t.create('Tag')
.get('/tag/photonstorm/phaser.json')
.expectJSONTypes(Joi.object().keys({ name: 'tag', value: Joi.string() }))

t.create('Tag (inc pre-release)')
.get('/tag-pre/photonstorm/phaser.json')
.expectJSONTypes(Joi.object().keys({ name: 'tag', value: Joi.string() }))

t.create('Tag (repo not found)')
.get('/tag/badges/helmets.json')
.expectJSON({ name: 'tag', value: 'repo not found' })

const tagsFixture = [
{ name: 'cheese' }, // any old string
{ name: 'v1.3-beta3' }, // semver pre-release
{ name: 'v1.2' }, // semver release
]

t.create('Tag (mocked response, no pre-releases, semver ordering)')
.get('/tag/foo/bar.json?style=_shields_test')
.intercept(nock =>
nock('https://api.github.com')
.get('/repos/foo/bar/tags')
.reply(200, tagsFixture)
)
.expectJSON({ name: 'tag', value: 'v1.2', colorB: colorsB.blue })

t.create('Tag (mocked response, include pre-releases, semver ordering)')
.get('/tag-pre/foo/bar.json?style=_shields_test')
.intercept(nock =>
nock('https://api.github.com')
.get('/repos/foo/bar/tags')
.reply(200, tagsFixture)
)
.expectJSON({ name: 'tag', value: 'v1.3-beta3', colorB: colorsB.orange })

t.create('Tag (mocked response, date ordering)')
.get('/tag-date/foo/bar.json?style=_shields_test')
.intercept(nock =>
nock('https://api.github.com')
.get('/repos/foo/bar/tags')
.reply(200, tagsFixture)
)
.expectJSON({ name: 'tag', value: 'cheese', colorB: colorsB.blue })

t.create('Package version')
.get('/package-json/v/badges/shields.json')
.expectJSONTypes(
Expand Down