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

fix(release): strip prefix before comparing version #1255

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 10 additions & 3 deletions dist/index.js
Expand Up @@ -142893,11 +142893,17 @@ const { getVersionInfo } = __nccwpck_require__(49914)
const { template } = __nccwpck_require__(47282)
const { log } = __nccwpck_require__(71911)

const sortReleases = (releases) => {
const sortReleases = (releases, tagPrefix) => {
// For semver, we find the greatest release number
// For non-semver, we use the most recently merged
try {
return releases.sort((r1, r2) => compareVersions(r1.tag_name, r2.tag_name))
const tagPrefixRexExp = new RegExp(`^${regexEscape(tagPrefix)}`)
return releases.sort((r1, r2) =>
compareVersions(
r1.tag_name.replace(tagPrefixRexExp, ''),
r2.tag_name.replace(tagPrefixRexExp, '')
)
)
} catch {
return releases.sort(
(r1, r2) => new Date(r1.created_at) - new Date(r2.created_at)
Expand Down Expand Up @@ -142948,7 +142954,8 @@ const findReleases = async ({
const sortedSelectedReleases = sortReleases(
filteredReleases.filter(
(r) => !r.draft && (!r.prerelease || includePreReleases)
)
),
tagPrefix
)
const draftRelease = filteredReleases.find((r) => r.draft)
const lastRelease = sortedSelectedReleases[sortedSelectedReleases.length - 1]
Expand Down
13 changes: 10 additions & 3 deletions lib/releases.js
Expand Up @@ -5,11 +5,17 @@ const { getVersionInfo } = require('./versions')
const { template } = require('./template')
const { log } = require('./log')

const sortReleases = (releases) => {
const sortReleases = (releases, tagPrefix) => {
// For semver, we find the greatest release number
// For non-semver, we use the most recently merged
try {
return releases.sort((r1, r2) => compareVersions(r1.tag_name, r2.tag_name))
const tagPrefixRexExp = new RegExp(`^${regexEscape(tagPrefix)}`)
return releases.sort((r1, r2) =>
compareVersions(
r1.tag_name.replace(tagPrefixRexExp, ''),
r2.tag_name.replace(tagPrefixRexExp, '')
)
)
} catch {
return releases.sort(
(r1, r2) => new Date(r1.created_at) - new Date(r2.created_at)
Expand Down Expand Up @@ -60,7 +66,8 @@ const findReleases = async ({
const sortedSelectedReleases = sortReleases(
filteredReleases.filter(
(r) => !r.draft && (!r.prerelease || includePreReleases)
)
),
tagPrefix
)
const draftRelease = filteredReleases.find((r) => r.draft)
const lastRelease = sortedSelectedReleases[sortedSelectedReleases.length - 1]
Expand Down
44 changes: 43 additions & 1 deletion test/releases.test.js
@@ -1,4 +1,4 @@
const { generateChangeLog } = require('../lib/releases')
const { generateChangeLog, findReleases } = require('../lib/releases')
const { DEFAULT_CONFIG } = require('../lib/default-config')

const pullRequests = [
Expand Down Expand Up @@ -234,4 +234,46 @@ describe('releases', () => {
`)
})
})

describe('findReleases', () => {
it('should retrieve last release respecting semver, stripped prefix', async () => {
const paginate = jest.fn().mockResolvedValue([
{
tag_name: 'test-1.0.1',
target_commitish: 'master',
created_at: '2021-06-29T05:45:15Z',
},
{
tag_name: 'test-1.0.0',
target_commitish: 'master',
created_at: '2022-06-29T05:45:15Z',
},
])

const context = {
log: {
info: jest.fn(),
},
repo: jest.fn(),
payload: {
repository: 'test',
},
octokit: {
paginate,
repos: { listReleases: { endpoint: { merge: jest.fn() } } },
},
}
const targetCommitish = 'refs/heads/master'
const filterByCommitish = ''
const tagPrefix = 'test-'

const { lastRelease } = await findReleases({
context,
targetCommitish,
filterByCommitish,
tagPrefix,
})
expect(lastRelease.tag_name).toEqual('test-1.0.1')
})
})
})