feat: add change default versioning strategy

Author: lukekarrys

lib/release-please/changelog.js

@@ -1,15 +1,15 @@
-const { DefaultChangelogNotes } = require('release-please/build/src/changelog-notes/default')
+const RP = require('release-please/build/src/changelog-notes/default')
 
-module.exports = class ChangelogNotes {
+module.exports = class DefaultChangelogNotes extends RP.DefaultChangelogNotes {
   constructor (options) {
-    this.defaultGenerator = new DefaultChangelogNotes(options)
+    super(options)
     this.github = options.github
   }
 
   async buildDefaultNotes (commits, options) {
     // The default generator has a title with the version and date
     // and a link to the diff between the last two versions
-    const notes = await this.defaultGenerator.buildNotes(commits, options)
+    const notes = await super.buildNotes(commits, options)
     const lines = notes.split('\n')
 
     let foundBreakingHeader = false

lib/release-please/index.js

@@ -1,9 +1,11 @@
-const { Manifest, GitHub, registerChangelogNotes, setLogger } = require('release-please')
-const { CheckpointLogger } = require('release-please/build/src/util/logger')
-const ChangelogNotes = require('./changelog')
+const RP = require('release-please')
+const logger = require('./logger.js')
+const ChangelogNotes = require('./changelog.js')
+const Version = require('./version.js')
 
-setLogger(new CheckpointLogger(true, true))
-registerChangelogNotes('default', (options) => new ChangelogNotes(options))
+RP.setLogger(logger)
+RP.registerChangelogNotes('default', (options) => new ChangelogNotes(options))
+RP.registerVersioningStrategy('default', (options) => new Version(options))
 
 const main = async ({ repo: fullRepo, token, dryRun, branch }) => {
   if (!token) {
@@ -15,8 +17,8 @@ const main = async ({ repo: fullRepo, token, dryRun, branch }) => {
   }
 
   const [owner, repo] = fullRepo.split('/')
-  const github = await GitHub.create({ owner, repo, token })
-  const manifest = await Manifest.fromManifest(
+  const github = await RP.GitHub.create({ owner, repo, token })
+  const manifest = await RP.Manifest.fromManifest(
     github,
     branch ?? github.repository.defaultBranch
   )

lib/release-please/logger.js

@@ -0,0 +1,3 @@
+const { CheckpointLogger } = require('release-please/build/src/util/logger')
+
+module.exports = new CheckpointLogger(true, true)

lib/release-please/version.js

@@ -0,0 +1,83 @@
+const semver = require('semver')
+
+// A way to compare the "level" of a release since we ignore some things during prereleases
+const LEVELS = new Map([['prerelease', 4], ['major', 3], ['minor', 2], ['patch', 1]]
+  .flatMap((kv) => [kv, kv.slice().reverse()]))
+
+const parseVersion = (v) => {
+  const { prerelease, minor, patch, version } = semver.parse(v)
+  const hasPre = prerelease.length > 0
+  const preId = prerelease.filter(p => typeof p === 'string').join('.')
+  const release = !patch ? (minor ? LEVELS.get('minor') : LEVELS.get('major')) : LEVELS.get('patch')
+  return { version, release, prerelease: hasPre, preId }
+}
+
+const parseCommits = (commits, prerelease) => {
+  let release = LEVELS.get('patch')
+  for (const commit of commits) {
+    if (commit.breaking) {
+      release = LEVELS.get('major')
+      break
+    } else if (['feat', 'feature'].includes(commit.type)) {
+      release = LEVELS.get('minor')
+    }
+  }
+  return { release, prerelease: !!prerelease }
+}
+
+const preInc = ({ version, prerelease, preId }, release) => {
+  if (!release.startsWith('pre')) {
+    release = `pre${release}`
+  }
+  // `pre` is the default prerelease identifier when creating a new
+  // prerelease version
+  return semver.inc(version, release, prerelease ? preId : 'pre')
+}
+
+const releasePleaseVersion = (v) => {
+  const { major, minor, patch, prerelease } = semver.parse(v)
+  const result = {
+    major,
+    minor,
+    patch,
+  }
+  if (prerelease.length) {
+    // release please wants it capitalized like this
+    result.preRelease = prerelease.join('.')
+  }
+  return result
+}
+
+// This does not account for pre v1 semantics since we don't publish those
+// Always 1.0.0 your initial versions!
+module.exports = class DefaultVersioningStrategy {
+  constructor (options) {
+    this.prerelease = options.prerelease
+  }
+
+  bump (currentVersion, commits) {
+    const next = parseCommits(commits, this.prerelease)
+    const current = parseVersion(currentVersion)
+
+    // This is a special case where semver doesn't align exactly with what we want.
+    // We are currently at a prerelease and our next is also a prerelease.
+    // In this case we want to ignore the release type we got from our conventional
+    // commits if the "level" of the next release is <= the level of the current one.
+    //
+    // This has the effect of only bumping the prerelease identifier and nothing else
+    // when we are actively working (and breaking) a prerelease. For example:
+    //
+    // `9.0.0-pre.4` + breaking changes = `9.0.0-pre.5`
+    // `8.5.0-pre.4` + breaking changes = `9.0.0-pre.0`
+    // `8.5.0-pre.4` + feature or patch changes = `8.5.0-pre.5`
+    if (current.prerelease && next.prerelease && next.release <= current.release) {
+      next.release = LEVELS.get('prerelease')
+    }
+
+    const release = LEVELS.get(next.release)
+    const releaseVersion = next.prerelease
+      ? preInc(current, release)
+      : semver.inc(current.version, release)
+    return releasePleaseVersion(releaseVersion)
+  }
+}

test/release-please/version.js

@@ -0,0 +1,62 @@
+const t = require('tap')
+const Version = require('../../lib/release-please/version.js')
+
+const COMMITS = {
+  major: [{ type: 'feat' }, {}, {}, { breaking: true }],
+  minor: [{}, {}, { type: 'feat' }],
+  patch: [{}, { type: 'chore' }, { type: 'fix' }],
+}
+
+const COMMIT_NAME = (c) => Object.entries(COMMITS).find(([, i]) => i === c)[0]
+
+t.test('bumps', async (t) => {
+  const checks = [
+    // Normal releases
+    ['2.0.0', COMMITS.major, false, '3.0.0'],
+    ['2.0.0', COMMITS.minor, false, '2.1.0'],
+    ['2.0.0', COMMITS.patch, false, '2.0.1'],
+    // premajor -> normal
+    ['2.0.0-pre.1', COMMITS.major, false, '2.0.0'],
+    ['2.0.0-pre.5', COMMITS.minor, false, '2.0.0'],
+    ['2.0.0-pre.4', COMMITS.patch, false, '2.0.0'],
+    // preminor -> normal
+    ['2.1.0-pre.1', COMMITS.major, false, '3.0.0'],
+    ['2.1.0-pre.5', COMMITS.minor, false, '2.1.0'],
+    ['2.1.0-pre.4', COMMITS.patch, false, '2.1.0'],
+    // prepatch -> normal
+    ['2.0.1-pre.1', COMMITS.major, false, '3.0.0'],
+    ['2.0.1-pre.5', COMMITS.minor, false, '2.1.0'],
+    ['2.0.1-pre.4', COMMITS.patch, false, '2.0.1'],
+    // Prereleases
+    ['2.0.0', COMMITS.major, true, '3.0.0-pre.0'],
+    ['2.0.0', COMMITS.minor, true, '2.1.0-pre.0'],
+    ['2.0.0', COMMITS.patch, true, '2.0.1-pre.0'],
+    // premajor - prereleases
+    ['2.0.0-pre.1', COMMITS.major, true, '2.0.0-pre.2'],
+    ['2.0.0-pre.1', COMMITS.minor, true, '2.0.0-pre.2'],
+    ['2.0.0-pre.1', COMMITS.patch, true, '2.0.0-pre.2'],
+    // preminor - prereleases
+    ['2.1.0-pre.1', COMMITS.major, true, '3.0.0-pre.0'],
+    ['2.1.0-pre.1', COMMITS.minor, true, '2.1.0-pre.2'],
+    ['2.1.0-pre.1', COMMITS.patch, true, '2.1.0-pre.2'],
+    // prepatch - prereleases
+    ['2.0.1-pre.1', COMMITS.major, true, '3.0.0-pre.0'],
+    ['2.0.1-pre.1', COMMITS.minor, true, '2.1.0-pre.0'],
+    ['2.0.1-pre.1', COMMITS.patch, true, '2.0.1-pre.2'],
+    // different prerelease identifiers
+    ['2.0.0-beta.1', COMMITS.major, true, '2.0.0-beta.2'],
+    ['2.0.0-alpha.1', COMMITS.major, true, '2.0.0-alpha.2'],
+    ['2.0.0-rc.1', COMMITS.major, true, '2.0.0-rc.2'],
+    ['2.0.0-0', COMMITS.major, true, '2.0.0-1'],
+  ]
+
+  for (const [version, commits, prerelease, expected] of checks) {
+    const name = [version, COMMIT_NAME(commits), prerelease ? 'pre' : 'normal', expected]
+    const r = new Version({ prerelease }).bump(version, commits)
+    t.equal(
+      `${r.major}.${r.minor}.${r.patch}${r.preRelease ? `-${r.preRelease}` : ''}`,
+      expected,
+      name.join(' - ')
+    )
+  }
+})