@oorabona/release-it-preset 0.3.0 → 0.4.0

package/README.md

@@ -2,6 +2,13 @@
 
 Shared [release-it](https://github.com/release-it/release-it) configuration and scripts for automated versioning, changelog generation, and package publishing.
 
+[![codecov](https://codecov.io/github/oorabona/release-it-preset/graph/badge.svg?token=6RMN34Z7TX)](https://codecov.io/github/oorabona/release-it-preset)
+[![CI](https://github.com/oorabona/release-it-preset/actions/workflows/ci.yml/badge.svg)](https://github.com/oorabona/release-it-preset/actions/workflows/ci.yml)
+[![NPM Version](https://img.shields.io/npm/v/release-it-preset.svg)](https://npmjs.org/package/@oorabona/release-it-preset)
+[![NPM Downloads](https://img.shields.io/npm/dm/release-it-preset.svg)](https://npmjs.org/package/@oorabona/release-it-preset)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.3+-blue.svg)](https://www.typescriptlang.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 ## Features
 
 - 📦 Multiple release configurations for different scenarios
@@ -469,6 +476,7 @@ Customize behavior with environment variables:
 - `GIT_REQUIRE_UPSTREAM` - Require upstream tracking (default: `false`)
 - `GIT_REQUIRE_CLEAN` - Require clean working directory (default: `false`)
 - `GIT_REMOTE` - Git remote name (default: `origin`)
+- `GIT_CHANGELOG_COMMAND` - Override the git log command used for previews (default filters out release/hotfix/ci commits)
 
 ### GitHub
 - `GITHUB_RELEASE` - Enable GitHub releases (default: `false`)
@@ -608,7 +616,7 @@ jobs:
       - name: Update GitHub release and publish to npm
         run: pnpm release-it-preset retry-publish --ci
         env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
           NPM_PUBLISH: 'true'
           GITHUB_RELEASE: 'true'
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -619,7 +627,7 @@ jobs:
 - `GITHUB_TOKEN` is provided automatically by GitHub Actions (no manual secret needed)
 
 **Required Permissions (locally):**
-- Set `GITHUB_RELEASE=true` and/or `NPM_PUBLISH=true` only when you explicitly want to perform those actions from your machine. Provide `GITHUB_TOKEN`/`NODE_AUTH_TOKEN` as needed.
+- Set `GITHUB_RELEASE=true` and/or `NPM_PUBLISH=true` only when you explicitly want to perform those actions from your machine. Provide `GITHUB_TOKEN`/`NPM_TOKEN` as needed.
 
 ### Alternative: Full CI Release
 
@@ -648,7 +656,7 @@ jobs:
       - run: pnpm release-it-preset default --ci --increment ${{ inputs.version }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
           GITHUB_RELEASE: 'true'
           NPM_PUBLISH: 'true'
 ```

package/config/default.js

@@ -17,10 +17,11 @@
  * ```
  */
 
-import { createReleaseNotesGenerator, runScriptCommand } from './helpers.js';
+import { createReleaseNotesGenerator, getGitChangelogCommand, runScriptCommand } from './helpers.js';
 
 const config = {
   git: {
+    changelog: getGitChangelogCommand(),
     commitMessage: process.env.GIT_COMMIT_MESSAGE || 'release: bump v${version}',
     tagName: process.env.GIT_TAG_NAME || 'v${version}',
     requireBranch: process.env.GIT_REQUIRE_BRANCH || 'main',

package/config/helpers.js

@@ -5,6 +5,20 @@ import { fileURLToPath } from 'node:url';
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 const RUN_SCRIPT_PATH = join(__dirname, '..', 'bin', 'run-script.js');
+const DEFAULT_CHANGELOG_COMMAND = [
+  'git log',
+  '--pretty=format:"* %s (%h)"',
+  '${from}..${to}',
+  '--grep="^release"',
+  '--grep="^Release"',
+  '--grep="^release-"',
+  '--grep="^Release-"',
+  '--grep="^hotfix"',
+  '--grep="^Hotfix"',
+  '--grep="^ci"',
+  '--grep="^CI"',
+  '--invert-grep',
+].join(' ');
 
 const DOUBLE_QUOTE = /["\\]/g;
 
@@ -50,3 +64,7 @@ export function createReleaseNotesGenerator() {
     return output ? `${output}\n` : fallbackReleaseNotes(version);
   };
 }
+
+export function getGitChangelogCommand() {
+  return process.env.GIT_CHANGELOG_COMMAND || DEFAULT_CHANGELOG_COMMAND;
+}

package/config/hotfix.js

@@ -14,12 +14,12 @@
  * ```
  */
 
-import { createReleaseNotesGenerator, runScriptCommand } from './helpers.js';
+import { createReleaseNotesGenerator, getGitChangelogCommand, runScriptCommand } from './helpers.js';
 
 const config = {
   increment: process.env.HOTFIX_INCREMENT || 'patch',
   git: {
-    changelog: 'git log --pretty=format:"- %s" ${latestTag}..HEAD',
+    changelog: getGitChangelogCommand(),
     commitMessage: process.env.GIT_COMMIT_MESSAGE || 'hotfix: bump v${version}',
     tagName: process.env.GIT_TAG_NAME || 'v${version}',
     requireBranch: process.env.GIT_REQUIRE_BRANCH || 'main',

package/config/manual-changelog.js

@@ -29,10 +29,11 @@
  * ```
  */
 
-import { createReleaseNotesGenerator, runScriptCommand } from './helpers.js';
+import { createReleaseNotesGenerator, getGitChangelogCommand, runScriptCommand } from './helpers.js';
 
 const config = {
   git: {
+    changelog: getGitChangelogCommand(),
     commitMessage: process.env.GIT_COMMIT_MESSAGE || 'release: bump v${version}',
     tagName: process.env.GIT_TAG_NAME || 'v${version}',
     requireBranch: process.env.GIT_REQUIRE_BRANCH || 'main',

package/config/republish.js

@@ -18,11 +18,12 @@
  * ```
  */
 
-import { createReleaseNotesGenerator, runScriptCommand } from './helpers.js';
+import { createReleaseNotesGenerator, getGitChangelogCommand, runScriptCommand } from './helpers.js';
 
 const config = {
   increment: false,
   git: {
+    changelog: getGitChangelogCommand(),
     commitMessage: process.env.GIT_COMMIT_MESSAGE || 'chore: republish v${version}',
     tagName: process.env.GIT_TAG_NAME || 'v${version}',
     tagAnnotation: 'Release ${version} (republished)',

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

@@ -97,6 +97,12 @@ export function parseCommitsWithMultiplePrefixes(gitOutput, repoUrl) {
             if (parts.length === 0) {
                 const firstLine = body.split('\n')[0].trim();
                 if (firstLine) {
+                    const lowerFirstLine = firstLine.toLowerCase();
+                    const ignoredPatterns = [/^release\b/, /^hotfix\b/, /^ci\b/];
+                    const shouldSkip = ignoredPatterns.some((pattern) => pattern.test(lowerFirstLine));
+                    if (shouldSkip) {
+                        continue;
+                    }
                     allParts.push({
                         type: 'misc',
                         description: firstLine,

package/dist/scripts/validate-release.js

@@ -157,7 +157,7 @@ export function validateNpmAuth(deps) {
         };
     }
     catch (error) {
-        const tokenEnvVars = ['NPM_TOKEN', 'NODE_AUTH_TOKEN', 'NPM_CONFIG__AUTH', 'NPM_CONFIG_TOKEN'];
+        const tokenEnvVars = ['NPM_TOKEN', 'NPM_TOKEN', 'NPM_CONFIG__AUTH', 'NPM_CONFIG_TOKEN'];
         const hasAutomationToken = tokenEnvVars.some((name) => {
             const value = deps.getEnv(name);
             return typeof value === 'string' && value.trim().length > 0;

package/package.json

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