@entro314labs/release-kit 2.4.0 → 2.5.0

package/README.md

@@ -621,6 +621,18 @@ jobs:
       - run: goreleaser release --clean --release-notes dist-notes.md
 ```
 
+A Go project has no version file at all — the tag is the version — so it is
+`"versionFile": null` and the version is passed explicitly, or inferred with `auto`:
+
+```sh
+release-kit auto      # bump from the commits, tag, push; goreleaser takes it from there
+```
+
+**Only one of the two should write release notes.** goreleaser groups conventional commits
+itself; `--release-notes` makes it use yours instead and skip its own generation. Leaving
+both on means the notes in the GitHub release and the notes in your `CHANGELOG.md` are
+generated by different code from the same commits, and they drift.
+
 **Do not leave `release` in `steps` here.** goreleaser creates the GitHub release itself; if
 release-kit has already created one for that tag, goreleaser fails. Exactly one of them
 should own it, and it should be the one attaching the binaries.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@entro314labs/release-kit",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "Single-file, zero-dependency release mechanism for JS/TS/Node projects: version bump, changelog roll, commit, annotated tag, push, publish, GitHub release",
   "keywords": [
     "changelog",

package/release.mjs

@@ -419,6 +419,7 @@ const CHANGELOG_SECTIONS = [
   { type: 'fix', section: 'Bug Fixes' },
   { type: 'perf', section: 'Performance Improvements' },
   { type: 'revert', section: 'Reverts' },
+  { type: 'deps', section: 'Dependencies' },
   { type: 'docs', section: 'Documentation', hidden: true },
   { type: 'style', section: 'Styles', hidden: true },
   { type: 'refactor', section: 'Code Refactoring', hidden: true },
@@ -435,7 +436,9 @@ const CHANGELOG_SECTIONS = [
  *   releaseAs: string|null} | null} null when the subject is not Conventional Commits
  */
 function parseCommit(subject, body = '', hash = '') {
-  const match = /^([a-z]+)(?:\(([^)]+)\))?(!)?: (.+)$/i.exec(subject)
+  // Conventional Commits does not restrict the type to letters — `i18n:` and `a11y:` are
+  // types people really use, and `[a-z]+` silently failed to parse them at all.
+  const match = /^([a-z][a-z0-9-]*)(?:\(([^)]+)\))?(!)?: (.+)$/i.exec(subject)
   if (!match) return null
   const [, type, scope, bang, text] = match
   const shortHash = hash.slice(0, 7)
@@ -519,6 +522,7 @@ function changelogFromCommits(commits, links = null) {
     lines.push('')
   }
 
+  const known = new Set(CHANGELOG_SECTIONS.map((s) => s.type))
   for (const { type, section, hidden } of CHANGELOG_SECTIONS) {
     if (hidden) continue
     const inSection = parsed.filter(
@@ -530,6 +534,16 @@ function changelogFromCommits(commits, links = null) {
     lines.push('')
   }
 
+  // A conventional type nobody anticipated — `security:`, `i18n:` — is still a change
+  // someone made deliberately. Dropping it silently is how a security fix goes unmentioned.
+  // The hidden types are excluded because hiding them is the point.
+  const other = parsed.filter((c) => !known.has(c.type) && c.type !== 'feature')
+  if (other.length) {
+    lines.push('### Other Changes', '')
+    for (const c of other) lines.push(bullet(c, c.subject))
+    lines.push('')
+  }
+
   return lines.length ? lines.join('\n').trim() : null
 }
 
@@ -1188,7 +1202,20 @@ if (versionFile && !existsSync(versionFile.path)) {
   abort(`versionFile ${versionFile.path} does not exist`)
 }
 
-const currentVersion = versionFile ? readVersionFrom(versionFile) : null
+/**
+ * Where a repository versions by tag alone — a Go module, a docs site — the latest tag is
+ * the current version. Without this, `auto` and every bump have nothing to work from and
+ * the version has to be typed out in full every time.
+ */
+function versionFromLastTag() {
+  const tag = tryRead('git', ['describe', '--tags', '--abbrev=0'])
+  if (!tag) return null
+  const bare =
+    config.tagPrefix && tag.startsWith(config.tagPrefix) ? tag.slice(config.tagPrefix.length) : tag
+  return parseVersion(bare) ? bare : null
+}
+
+const currentVersion = versionFile ? readVersionFrom(versionFile) : versionFromLastTag()
 if (versionFile && !currentVersion) {
   abort(`could not read a version from ${versionFile.path}`)
 }
@@ -1280,14 +1307,17 @@ let version
 if (!target) {
   if (!currentVersion) {
     abort(
-      'this repository has no versionFile, so there is no version to default to.\n' +
-        '  Pass one explicitly: release-kit 1.2.3',
+      'nothing to default to: this repository has no versionFile and no tag to read a ' +
+        'version from.\n  Pass one explicitly: release-kit 1.2.3',
     )
   }
   version = currentVersion
 } else if (target === 'auto') {
   if (!currentVersion) {
-    abort('auto needs a versionFile to bump from. Pass a version explicitly instead.')
+    abort(
+      'auto has nothing to bump from: there is no versionFile and no tag to read a version ' +
+        'from.\n  Pass the first version explicitly: release-kit 0.1.0',
+    )
   }
   const { commits, lastTag } = commitsSinceLastTag()
   if (!commits.length) {
@@ -1310,7 +1340,10 @@ if (!target) {
   }
 } else if (BUMPS.has(target)) {
   if (!currentVersion) {
-    abort(`a ${target} bump needs a versionFile to bump from. Pass a version explicitly instead.`)
+    abort(
+      `a ${target} bump has nothing to bump from: no versionFile, and no tag to read a ` +
+        'version from.\n  Pass the version explicitly instead.',
+    )
   }
   const preid = requestedPreid ?? preidOf(currentVersion)
   if (target.startsWith('pre') && !preid) {