calver-bump 1.0.0 → 1.0.1

package/README.md

@@ -2,16 +2,23 @@
 
 Release CLI for applications and internal tools that use readable CalVer versions.
 
-Default version and tag format:
+Default version format:
 
 ```text
 YY.MMDD
 ```
 
-Example:
+Default git tag format:
+
+```text
+vYY.MMDD
+```
+
+Example package version and git tag:
 
 ```text
 26.0529
+v26.0529
 ```
 
 ## What it does
@@ -20,7 +27,8 @@ Example:
 2. Updates `package-lock.json` or `npm-shrinkwrap.json` when present.
 3. Warns when `pnpm-lock.yaml` or `yarn.lock` is present, because those lockfiles do not store the root package version consistently.
 4. Creates or prepends a `CHANGELOG.md` entry from conventional commits since the nearest reachable tag.
-5. Prints the git commands needed to commit, tag, and push the reviewed release.
+5. Creates a release commit.
+6. Creates an annotated git tag.
 
 ## Usage
 
@@ -28,7 +36,7 @@ Example:
 npx calver-bump
 ```
 
-By default, `calver-bump` updates files only. Review `CHANGELOG.md`, then run the printed git commands when the release notes are correct.
+By default, `calver-bump` updates release files, creates a release commit, and creates an annotated `v`-prefixed git tag.
 
 Preview the planned release without writing files:
 
@@ -60,10 +68,10 @@ Use long CalVer instead:
 npx calver-bump --format long
 ```
 
-Create a `v`-prefixed git tag while keeping `package.json` unprefixed:
+Create an unprefixed git tag while keeping the default package version unchanged:
 
 ```bash
-npx calver-bump --tag-prefix v
+npx calver-bump --tag-prefix ""
 ```
 
 Push the release commit and annotated tag:
@@ -165,11 +173,12 @@ The package includes a manual GitHub Actions publish workflow. Run the `Publish`
 - Changelog entries fall back to commit hash links for GitHub and GitLab-style remotes when no pull/merge request reference is found.
 - Release entries include a `Full Changelog` section with a deduped list of pull/merge requests found in the release range, including the local commit title when available.
 - Later releases prepend only commits since the previous nearest reachable tag.
-- Plain `calver-bump` does not commit or tag by default; it prints the follow-up `git add`, `git commit`, `git tag`, and `git push --follow-tags` commands.
+- Plain `calver-bump` creates the release commit and annotated tag by default.
 - Use `--commit` to create only the release commit.
 - Use `--tag` to create the release commit and annotated tag.
+- Use `--skip-commit` to update files only without creating a release commit or tag.
 - Use `--push` to create the release commit, create the annotated tag, and push both.
 - Release tags are annotated so `git push --follow-tags <remote> <branch>` pushes them.
-- The working tree must be clean before creating a real release.
+- Unrelated dirty working-tree files do not block a release; only release files are staged.
 - Existing release tags are rejected before files are written.
 - If tag creation fails after the release commit, the CLI undoes its own commit and leaves the file changes in the working tree for inspection or recovery.

package/bin/calver-bump.js

@@ -75,12 +75,15 @@ async function releaseOptions(args) {
   const changelogOnly = flag(args, '--changelog-only') ?? config.changelogOnly ?? false;
   const skipCommit = flag(args, '--skip-commit') ?? config.skipCommit ?? false;
   const push = flag(args, '--push') ?? config.push ?? false;
-  const tag = push || (flag(args, '--tag') ?? config.tag ?? false);
-  const commit = tag || (flag(args, '--commit') ?? config.commit ?? false);
+  const commitFlag = flag(args, '--commit');
+  const tagFlag = flag(args, '--tag');
+  const writesOnly = skipCommit || versionOnly || changelogOnly;
+  const tag = !writesOnly && (push || (tagFlag ?? config.tag ?? (commitFlag || config.commit ? false : true)));
+  const commit = tag || (!writesOnly && (commitFlag ?? config.commit ?? false));
   if (versionOnly && changelogOnly) {
     throw new Error('--version-only cannot be combined with --changelog-only.');
   }
-  if (skipCommit && (commit || tag || push)) {
+  if (skipCommit && (commitFlag || tagFlag || config.commit || config.tag || push)) {
     throw new Error('--skip-commit cannot be combined with --commit, --tag, or --push.');
   }
   return {
@@ -96,7 +99,7 @@ async function releaseOptions(args) {
     from: value(args, '--from') ?? config.from,
     format: value(args, '--format') ?? config.format ?? 'short',
     remote: value(args, '--remote') ?? config.remote ?? 'origin',
-    tagPrefix: value(args, '--tag-prefix') ?? config.tagPrefix ?? '',
+    tagPrefix: value(args, '--tag-prefix') ?? config.tagPrefix ?? 'v',
     types: parseTypes(value(args, '--types')) ?? config.types,
     changelogSections: config.changelogSections,
   };
@@ -204,7 +207,7 @@ function helpText() {
 Options:
   --dry-run              Preview the release without writing files.
   --format <name>        Version format: short, compact, or long.
-  --tag-prefix <prefix>  Prefix the git tag without changing package.json.
+  --tag-prefix <prefix>  Prefix the git tag without changing package.json (default: v).
   --types <list>         Comma-separated conventional commit types to include.
   --from <tag>           Use an explicit changelog base tag.
   --no-fetch             Use local tags only; do not fetch remote tags.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "calver-bump",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Release CLI for internal applications using readable CalVer versions.",
   "repository": {
     "type": "git",

package/src/changelog.js

@@ -21,6 +21,7 @@ export async function releaseNotes(cwd, options = {}) {
   const conventionalCommits = dedupeConventionalChanges(commits
     .map((commit) => ({ ...commit, subject: conventionalSubjectForCommit(commit) ?? commit.subject }))
     .filter((commit) => isConventionalCommit(commit.subject))
+    .filter((commit) => !isReleaseCommit(commit.subject))
     .filter((commit) => allowedTypes.includes(conventionalType(commit.subject)))
     .filter((commit) => !isCommitInChangelog(commit, options.existingChangelog ?? ''))
     .map((commit) => ({
@@ -28,7 +29,10 @@ export async function releaseNotes(cwd, options = {}) {
       request: requestForCommit(commit, requestUrlBuilder),
       url: commitUrlBuilder ? commitUrlBuilder(commit.hash) : null,
     })));
-  const requests = uniqueRequests(commits.map((commit) => requestForCommit(commit, requestUrlBuilder)).filter(Boolean));
+  const requests = uniqueRequests(commits
+    .filter((commit) => !isReleaseCommit(conventionalSubjectForCommit(commit) ?? commit.subject))
+    .map((commit) => requestForCommit(commit, requestUrlBuilder))
+    .filter(Boolean));
   return {
     previousTag: latestTag,
     range: latestTag ? `${latestTag}..HEAD` : 'HEAD',
@@ -102,6 +106,10 @@ function isConventionalCommit(subject) {
   return /^(feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert)(\([^)]+\))?!?: .+/.test(subject);
 }
 
+function isReleaseCommit(subject) {
+  return /^chore\(release\):\s.+/.test(subject);
+}
+
 function conventionalSubjectForCommit(commit) {
   return commitLines(commit).find((line) => isConventionalCommit(line)) ?? null;
 }
@@ -133,14 +141,16 @@ function conventionalType(subject) {
 
 function formatCommitEntry(commit) {
   const shortHash = commit.hash.slice(0, 7);
-  const suffix = commit.request
-    ? ` (${formatRequestLink(commit.request)})`
-    : commit.url ? ` ([${shortHash}](${commit.url}))` : ` (${shortHash})`;
+  const links = [
+    shortHash,
+    commit.request ? formatRequestLink(commit.request) : null,
+  ].filter(Boolean);
+  const suffix = ` (${links.join(', ')})`;
   return `${commit.subject}${suffix}`;
 }
 
 function formatRequestLink(request) {
-  return request.url ? `[${request.label}](${request.url})` : request.label;
+  return request.label;
 }
 
 function formatRequestEntry(request) {
@@ -221,7 +231,7 @@ function requestTitleForCommit(commit) {
 }
 
 function parseRequestReference(message) {
-  const gitlabMerge = /(?:^|\s)(?:See merge request\s+\S+!|!)(?<number>\d+)(?=\D|$)/i.exec(message);
+  const gitlabMerge = /(?:^|[\s(])(?:See merge request\s+\S+!|!)(?<number>\d+)(?=\D|$)/i.exec(message);
   if (gitlabMerge) {
     return { provider: 'gitlab', number: gitlabMerge.groups.number, label: `!${gitlabMerge.groups.number}` };
   }
@@ -258,7 +268,7 @@ function parseGitRemote(remote) {
     return sshMatch.groups;
   }
 
-  const httpsMatch = /^https:\/\/(?<host>[^/]+)\/(?<repo>.+?)(?:\.git)?$/.exec(remote);
+  const httpsMatch = /^https?:\/\/(?<host>[^/]+)\/(?<repo>.+?)(?:\.git)?$/.exec(remote);
   if (httpsMatch) {
     return httpsMatch.groups;
   }

package/src/index.js

@@ -8,7 +8,7 @@ import {
   updatePackageVersion,
   writeChangelog,
 } from './files.js';
-import { assertCleanWorktree, assertTagAvailable, currentBranch, git, gitLines } from './git.js';
+import { assertTagAvailable, currentBranch, git, gitLines } from './git.js';
 
 export async function planRelease(options = {}) {
   const cwd = options.cwd ?? process.cwd();
@@ -18,7 +18,7 @@ export async function planRelease(options = {}) {
     existingTags,
     format: options.format ?? 'short',
   });
-  const tag = `${options.tagPrefix ?? ''}${version}`;
+  const tag = `${options.tagPrefix ?? 'v'}${version}`;
   const notes = options.versionOnly
     ? null
     : await releaseNotes(cwd, { ...options, tag, existingChangelog: await readChangelog(cwd) });
@@ -59,7 +59,6 @@ export async function runRelease(options = {}) {
     return plan;
   }
 
-  await assertCleanWorktree(cwd);
   if (createsTag(options)) {
     await assertTagAvailable(cwd, plan.tag);
   }
@@ -124,16 +123,16 @@ async function prependChangelog(cwd, version, options = {}) {
   const notes = await releaseNotes(cwd, {
     ...options,
     existingChangelog: existing,
-    tag: `${options.tagPrefix ?? ''}${version}`,
+    tag: `${options.tagPrefix ?? 'v'}${version}`,
   });
   const heading = formatReleaseHeading({
     version,
     previousTag: notes.previousTag,
-    tag: options.tagPrefix ? `${options.tagPrefix}${version}` : version,
+    tag: `${options.tagPrefix ?? 'v'}${version}`,
     compareUrlBuilder: notes.compareUrlBuilder,
   });
   const compareUrl = notes.previousTag && notes.compareUrlBuilder
-    ? notes.compareUrlBuilder(notes.previousTag, options.tagPrefix ? `${options.tagPrefix}${version}` : version)
+    ? notes.compareUrlBuilder(notes.previousTag, `${options.tagPrefix ?? 'v'}${version}`)
     : null;
   const entry = `${heading}\n\n${formatReleaseNotes(notes.changes, options.changelogSections)}${formatFullChangelog(notes.requests, compareUrl)}\n`;