@oorabona/release-it-preset 0.10.1 → 0.12.0

package/README.md

@@ -660,6 +660,8 @@ Customize behavior with environment variables:
 
 ### Changelog
 - `CHANGELOG_FILE` - Changelog file path (default: `CHANGELOG.md`)
+- `GIT_CHANGELOG_PATH` - Optional. When set to a repository-relative path (e.g. `packages/tar-xz`), restrict changelog generation to commits touching that path. Useful for monorepo per-package CHANGELOG files. Empty / unset = repository-wide (default).
+- `GIT_CHANGELOG_SINCE` - Optional. Override the `since` baseline for changelog generation (any git ref: SHA, tag, branch). When set, bypasses both the per-package release-commit detection and the `git describe --tags` fallback. Useful for monorepo workspaces with non-standard release commit patterns. Empty / unset = use auto-detection.
 
 ### Git
 - `GIT_COMMIT_MESSAGE` - Commit message template (default: `release: bump v${version}`)
@@ -678,6 +680,7 @@ Customize behavior with environment variables:
 - `NPM_PUBLISH` - Enable npm publishing (default: `false`)
 - `NPM_SKIP_CHECKS` - Skip npm checks (default: `false`)
 - `NPM_ACCESS` - npm access level (default: `public`)
+- `NPM_TAG` - Optional. When set, the npm publish step appends `--tag <value>` (e.g. `legacy-v0.10.0`). Used to assign version-named dist-tags when republishing older versions so `latest` is not overwritten. Empty / unset = npm uses `latest`.
 
 > ℹ️  By default, the presets skip GitHub releases and npm publishing. Set `GITHUB_RELEASE=true` and/or `NPM_PUBLISH=true` in the environment (typically in CI) when you are ready to perform those steps.
 

package/config/base-config.js

@@ -41,15 +41,24 @@ export function createBaseGitConfig(overrides = {}) {
  * @returns {Object} Npm configuration object
  */
 export function createBaseNpmConfig(overrides = {}) {
+  const publishArgs = [
+    ...NPM_DEFAULTS.PUBLISH_ARGS_BASE,
+    '--access',
+    process.env.NPM_ACCESS || NPM_DEFAULTS.ACCESS,
+  ];
+
+  // Optional --tag <name> for npm dist-tag control (e.g. republishing an older
+  // version without overwriting `latest`). When unset, npm uses `latest`.
+  const npmTag = process.env.NPM_TAG;
+  if (npmTag) {
+    publishArgs.push('--tag', npmTag);
+  }
+
   const defaults = {
     skipChecks: process.env.NPM_SKIP_CHECKS === 'true',
     publish: process.env.NPM_PUBLISH === 'true',
     versionArgs: NPM_DEFAULTS.VERSION_ARGS,
-    publishArgs: [
-      ...NPM_DEFAULTS.PUBLISH_ARGS_BASE,
-      '--access',
-      process.env.NPM_ACCESS || NPM_DEFAULTS.ACCESS,
-    ],
+    publishArgs,
   };
 
   return {

package/dist/scripts/populate-unreleased-changelog.js

@@ -22,6 +22,7 @@ import { readFileSync, writeFileSync } from 'node:fs';
 import { getGitHubRepoUrl } from './lib/git-utils.js';
 import { CONVENTIONAL_COMMIT_REGEX } from './lib/commit-parser.js';
 import { runScript } from './lib/run-script.js';
+import { ValidationError } from './lib/errors.js';
 /**
  * Extract all conventional commit patterns from a commit body
  */
@@ -166,23 +167,81 @@ export function parseCommitsWithMultiplePrefixes(gitOutput, repoUrl) {
     return sections.length > 0 ? sections.join('\n').trim() : 'No changes yet.';
 }
 /**
- * Main function to populate changelog with dependency injection
+ * Resolve the `since` baseline for changelog generation.
+ *
+ * Priority:
+ * 1. GIT_CHANGELOG_SINCE env var (any git ref — trust the user)
+ * 2. Per-package detection via `chore(<pkg>): release v` commit when GIT_CHANGELOG_PATH is set
+ * 3. Fallback: `git describe --tags --abbrev=0`
  */
-export function populateChangelog(deps) {
-    const changelogPath = deps.getEnv('CHANGELOG_FILE') || 'CHANGELOG.md';
-    deps.log('📝 Populating [Unreleased] section...');
-    let latestTag;
+export function resolveSinceBaseline(deps) {
+    // 1. Explicit override wins
+    const sinceOverride = deps.getEnv('GIT_CHANGELOG_SINCE');
+    if (sinceOverride && sinceOverride.trim()) {
+        deps.log(`ℹ️  Using GIT_CHANGELOG_SINCE override: ${sinceOverride.trim()}`);
+        return sinceOverride.trim();
+    }
+    // 2. Per-package detection: only when running scoped to a subdir
+    const path = deps.getEnv('GIT_CHANGELOG_PATH');
+    if (path && path.trim()) {
+        let pkgName = '';
+        try {
+            const pkgJsonRaw = deps.readFileSync('package.json', 'utf8');
+            const pkgNameFull = JSON.parse(pkgJsonRaw).name;
+            if (pkgNameFull) {
+                pkgName = pkgNameFull.startsWith('@')
+                    ? (pkgNameFull.split('/').pop() ?? '')
+                    : pkgNameFull;
+            }
+        }
+        catch {
+            // package.json missing or unreadable — skip per-package detection
+        }
+        if (pkgName) {
+            try {
+                const sha = deps.execSync(`git log --grep="^chore(${pkgName}): release v" -n 1 --pretty=format:"%H"`, { encoding: 'utf8' }).trim();
+                if (sha) {
+                    deps.log(`ℹ️  Per-package baseline (chore(${pkgName}): release …): ${sha.substring(0, 7)}`);
+                    return sha;
+                }
+            }
+            catch {
+                // fall through to tag fallback
+            }
+        }
+    }
+    // 3. Fallback: existing git describe behavior
     try {
-        latestTag = deps.execSync('git describe --tags --abbrev=0 2>/dev/null', { encoding: 'utf8' }).trim();
-        deps.log(`ℹ️  Latest tag: ${latestTag}`);
+        const tag = deps.execSync('git describe --tags --abbrev=0 2>/dev/null', { encoding: 'utf8' }).trim();
+        deps.log(`ℹ️  Latest tag: ${tag}`);
+        return tag;
     }
     catch {
         deps.log('ℹ️  No tags found, using all commits');
-        latestTag = '';
+        return '';
+    }
+}
+/**
+ * Main function to populate changelog with dependency injection
+ */
+export function populateChangelog(deps) {
+    const changelogPath = deps.getEnv('CHANGELOG_FILE') || 'CHANGELOG.md';
+    deps.log('📝 Populating [Unreleased] section...');
+    const since = resolveSinceBaseline(deps);
+    const gitChangelogPath = deps.getEnv('GIT_CHANGELOG_PATH');
+    let pathFilter = '';
+    if (gitChangelogPath !== undefined && gitChangelogPath !== '') {
+        // Validate: must be a relative path — no leading slash, no ".." segments, no shell metacharacters
+        if (gitChangelogPath.startsWith('/') ||
+            /(^|[/\\])\.\.([/\\]|$)/.test(gitChangelogPath) ||
+            /[`$;&|<>{}()\\*?!#"']/.test(gitChangelogPath)) {
+            throw new ValidationError(`GIT_CHANGELOG_PATH must be a relative path under the repository (got: ${gitChangelogPath})`);
+        }
+        pathFilter = ` -- ${gitChangelogPath}`;
     }
-    const gitLogCommand = latestTag
-        ? `git log --pretty=format:"%H|%B|||END|||" ${latestTag}..HEAD`
-        : `git log --pretty=format:"%H|%B|||END|||"`;
+    const gitLogCommand = since
+        ? `git log --pretty=format:"%H|%B|||END|||" ${since}..HEAD${pathFilter}`
+        : `git log --pretty=format:"%H|%B|||END|||"${pathFilter}`;
     let gitOutput;
     try {
         gitOutput = deps.execSync(gitLogCommand, { encoding: 'utf8' }).trim();

package/dist/types/populate-unreleased-changelog.d.ts

@@ -50,6 +50,15 @@ export declare function normalizeCommitType(type: string): string | false;
  * Parse git log output and extract all conventional commit parts
  */
 export declare function parseCommitsWithMultiplePrefixes(gitOutput: string, repoUrl: string): string;
+/**
+ * Resolve the `since` baseline for changelog generation.
+ *
+ * Priority:
+ * 1. GIT_CHANGELOG_SINCE env var (any git ref — trust the user)
+ * 2. Per-package detection via `chore(<pkg>): release v` commit when GIT_CHANGELOG_PATH is set
+ * 3. Fallback: `git describe --tags --abbrev=0`
+ */
+export declare function resolveSinceBaseline(deps: PopulateChangelogDeps): string;
 /**
  * Main function to populate changelog with dependency injection
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oorabona/release-it-preset",
-  "version": "0.10.1",
+  "version": "0.12.0",
   "description": "Shared release-it configuration and scripts for the organisation",
   "type": "module",
   "keywords": [