relion 0.40.0 → 0.41.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -4,10 +4,10 @@
4
4
  <img alt="logo" src=".github/logo-dark.png">
5
5
  </picture>
6
6
  <br>
7
- <a href="https://www.npmjs.com/package/relion"><img src="https://img.shields.io/npm/v/relion?label=npm&logo=npm&style=flat-square&color=c8c9f1&labelColor=303145" alt="npm version"/></a>&nbsp;
8
- <a href="https://www.npmjs.com/package/relion"><img src="https://img.badgesize.io/https:/unpkg.com/relion/dist/index.js?label=Size&logo=hackthebox&logoColor=c97026&style=flat-square&color=c8c9f1&labelColor=303145" alt="runtime size"/></a>&nbsp;
9
- <a href="https://github.com/kh4f/relion/blob/master/LICENSE"><img src="https://img.shields.io/github/license/kh4f/relion?style=flat-square&label=%F0%9F%9B%A1%EF%B8%8F%20License&color=c8c9f1&labelColor=303145" alt="license"></a>&nbsp;
10
- <a href="https://github.com/kh4f/relion/issues?q=is%3Aissue+is%3Aopen+label%3Abug"><img src="https://img.shields.io/github/issues/kh4f/relion/bug?label=%F0%9F%90%9B%20Bugs&style=flat-square&color=c8c9f1&labelColor=303145" alt="open bugs"></a>
7
+ <a href="https://www.npmjs.com/package/relion"><img src="https://img.shields.io/npm/v/relion?label=npm&logo=npm&style=flat-square&color=B2BFFF&labelColor=303145" alt="npm version"/></a>&nbsp;
8
+ <a href="https://www.npmjs.com/package/relion"><img src="https://img.badgesize.io/https:/unpkg.com/relion/dist/index.js?label=Size&logo=hackthebox&logoColor=c97026&style=flat-square&color=B2BFFF&labelColor=303145" alt="runtime size"/></a>&nbsp;
9
+ <a href="https://github.com/kh4f/relion/blob/master/LICENSE"><img src="https://img.shields.io/github/license/kh4f/relion?style=flat-square&label=%F0%9F%9B%A1%EF%B8%8F%20License&color=B2BFFF&labelColor=303145" alt="license"></a>&nbsp;
10
+ <a href="https://github.com/kh4f/relion/issues?q=is%3Aissue+is%3Aopen+label%3Abug"><img src="https://img.shields.io/github/issues/kh4f/relion/bug?label=%F0%9F%90%9B%20Bugs&style=flat-square&color=B2BFFF&labelColor=303145" alt="open bugs"></a>
11
11
  <br><br>
12
12
  <b>A minimal npm library for automating release workflow:<br></b> version bumping, release commit & tag creation, and AI‑assisted changelog generation
13
13
  <br><br>
@@ -40,12 +40,14 @@ Options:
40
40
  -c Create a release commit
41
41
  -t Create a release tag
42
42
  -v <version> Set the new version explicitly
43
+ -m <file> Specify manifest file
43
44
  -d Run in dry run mode
44
45
  -h Show the help message
45
46
 
46
47
  Examples:
47
48
  - `pnpm relion -bct` — bump version, create release commit and tag
48
49
  - `pnpm relion -f` — generate release context file
50
+ - `pnpm relion -m Cargo.toml` — use Cargo.toml as manifest
49
51
  - `pnpm relion` — run all release steps
50
52
  ```
51
53
 
@@ -102,14 +104,17 @@ relion({
102
104
 
103
105
  ### Options
104
106
 
105
- - `flow`: release workflow steps (`'context' | 'bump' | 'commit' | 'tag'`) (default: `[]`)
107
+ - `manifest`: manifest file (default: auto-detects `package.json` or `Cargo.toml`)
108
+ - `flow`: release workflow steps (`'context' | 'bump' | 'commit' | 'tag'`) (default: all steps)
106
109
  - `newVersion`: set the new version explicitly
107
- - `bump`: files or custom bumpers for version update (default: [`'package.json'`])
110
+ - `bump`: files or custom bumpers for version update (default: [`'package.json', 'Cargo.toml'`])
108
111
  - `contextFile`: path to release context output file (default: `'RELEASE.md'`)
109
112
  - `commitMessage`: release commit message template (default: `'chore(release): {{tag}}'`)
110
113
  - `tagPrefix`: release tag prefix (default: `'v'`)
111
114
  - `dryRun`: run in dry mode (no modifications)
112
115
 
116
+ > For detailed option descriptions, see [src/types.d.ts](src/types.d.ts).
117
+
113
118
  ### Configuration via `package.json`
114
119
 
115
120
  Relion can also be configured via `relion` field in `package.json`:
package/dist/cli.js CHANGED
@@ -1,3 +1,4 @@
1
+ #!/usr/bin/env node
1
2
  import e from"./index.js";const t=process.argv.slice(2).join(` `);t.includes(`-h`)&&(console.log(`Usage: relion [options]
2
3
 
3
4
  Options:
@@ -6,11 +7,13 @@ Options:
6
7
  -c Create a release commit
7
8
  -t Create a release tag
8
9
  -v <version> Set the new version explicitly
10
+ -m <file> Specify manifest file
9
11
  -d Run in dry run mode
10
12
  -h Show the help message
11
13
 
12
14
  Examples:
13
15
  - \`pnpm relion -bct\` — bump version, create release commit and tag
14
16
  - \`pnpm relion -f\` — generate release context file
17
+ - \`pnpm relion -m Cargo.toml\` — use Cargo.toml as manifest
15
18
  - \`pnpm relion\` — run all release steps
16
- `),process.exit(0));let n=[/-\w*f/.test(t)&&`context`,/-\w*b/.test(t)&&`bump`,/-\w*c/.test(t)&&`commit`,/-\w*t/.test(t)&&`tag`].filter(Boolean);n.length||(n=[`context`,`bump`,`commit`,`tag`]);const r=/-v (\S+)/.exec(t)?.[1],i=/-\w*d/.test(t);e({flow:n,...r&&{newVersion:r},...i&&{dryRun:i}});export{};
19
+ `),process.exit(0));let n=[/-\w*f/.test(t)&&`context`,/-\w*b/.test(t)&&`bump`,/-\w*c/.test(t)&&`commit`,/-\w*t/.test(t)&&`tag`].filter(Boolean);n.length||(n=[`context`,`bump`,`commit`,`tag`]);const r=/-v (\S+)/.exec(t)?.[1],i=/-m (\S+)/.exec(t)?.[1],a=/-\w*d/.test(t);e({flow:n,...r&&{newVersion:r},...i&&{manifest:i},...a&&{dryRun:a}}).catch(e=>{console.error(e),process.exit(1)});export{};
package/dist/index.d.ts CHANGED
@@ -1,5 +1,7 @@
1
1
  //#region src/types.d.ts
2
2
  interface Config {
3
+ /** Manifest file path. Auto-detects `package.json` or `Cargo.toml` if omitted. */
4
+ manifest?: string;
3
5
  /**
4
6
  * Release workflow steps to execute (e.g. bump, context, commit, tag)
5
7
  * @default []
@@ -13,9 +15,11 @@ interface Config {
13
15
  /**
14
16
  * Files or bumpers for version update. Each item is either:
15
17
  * - a Bumper object specifying `file`, `pattern`, and `replacement`
16
- * - a file name for which a default bumper exists (currently only 'package.json')
18
+ * - a file name for which a default bumper exists (currently only 'package.json', 'Cargo.toml')
17
19
  *
18
- * @default ['package.json']
20
+ * If a file doesn't exist, it will be skipped silently.
21
+ *
22
+ * @default ['package.json', 'Cargo.toml']
19
23
  */
20
24
  bump?: (Bumper | string)[];
21
25
  /**
@@ -50,9 +54,9 @@ interface Bumper {
50
54
  }
51
55
  //#endregion
52
56
  //#region src/relion.d.ts
53
- declare const _default: (userCfg?: Config) => Promise<void>;
57
+ declare function relion(userCfg?: Config): Promise<void>;
54
58
  //#endregion
55
59
  //#region src/index.d.ts
56
60
  declare const defineConfig: (config: Config) => Config;
57
61
  //#endregion
58
- export { _default as default, defineConfig };
62
+ export { relion as default, defineConfig };
package/dist/index.js CHANGED
@@ -1,5 +1,5 @@
1
- import{readFileSync as e,writeFileSync as t}from"node:fs";import{execSync as n,spawnSync as r}from"node:child_process";import{createInterface as i}from"node:readline";import a from"semver";const o=e=>n(`git log ${e?`${e}..`:``} --format="%h %B---" .`,{encoding:`utf8`}).trim().split(`---`).filter(Boolean).map(e=>/^(.+?) (.+)/s.exec(e.trim())).map(e=>({hash:e?.[1]??``,message:e?.[2].trim()??``})),s=(e,t)=>{let n=e.some(e=>e.message.includes(`BREAKING CHANGE`))?t.startsWith(`0.`)?`minor`:`major`:e.some(e=>/feat(\(.*?\))?:/.test(e.message))?`minor`:`patch`;return a.inc(t,n)??(()=>{throw Error(`Failed to increment version '${t}' with release type '${n}'`)})()},c=async()=>{let e=i({input:process.stdin,output:process.stdout});return await new Promise(t=>{e.question(`Press Enter to continue ('s' to skip): `,n=>{e.close(),t(n.trim()!==`s`)})})},l=e=>{let t=/^\/(.+)\/(\w*)$/.exec(e);return t?new RegExp(t[1],t[2]):new RegExp(e)},u=[`context`,`bump`,`commit`,`tag`],d={file:`package.json`,pattern:/(\bversion\b.*?)\d[\w.+-]*/,replacement:`$1{{newVersion}}`},f={flow:[],newVersion:``,bump:[`package.json`],contextFile:`RELEASE.md`,commitMessage:`chore(release): {{tag}}`,tagPrefix:`v`,dryRun:!1},p=async(e,n,r,i,a)=>{if(console.log(`\nAbout to write context to '${e.contextFile}'`),!await c()||e.dryRun)return;let o=``,s=`---\nversion: ${e.newVersion}\ntag: ${i}\ndate: ${new Date().toLocaleString(`en-US`,{month:`short`,day:`numeric`,year:`numeric`})}\nprevTag: ${r}\nrepoURL: ${a}
1
+ import{existsSync as e,readFileSync as t,writeFileSync as n}from"node:fs";import{execSync as r,spawnSync as i}from"node:child_process";import{createInterface as a}from"node:readline";import o from"semver";const s=e=>{let n=t(e,`utf8`),r=/name.*"(.*?)"/.exec(n)?.[1];if(!r)throw Error(`Manifest is missing 'name' field`);let i=/version.*"(.*?)"/.exec(n)?.[1];if(!i)throw Error(`Manifest is missing 'version' field`);let a=/repository.*"(.*?)"/.exec(n)?.[1];if(!a)throw Error(`Manifest is missing 'repository' field`);let o=e.endsWith(`.json`)?/relion.*({.*?})/s.exec(n)?.[1]:void 0;return{name:r,version:i,repository:a,relion:o?JSON.parse(o):void 0}},c=e=>r(`git log ${e?`${e}..`:``} --format="%h %B---" .`,{encoding:`utf8`}).trim().split(`---`).filter(Boolean).map(e=>/^(.+?) (.+)/s.exec(e.trim())).map(e=>({hash:e?.[1]??``,message:e?.[2].trim()??``})),l=(e,t)=>{let n=e.some(e=>e.message.includes(`BREAKING CHANGE`))?t.startsWith(`0.`)?`minor`:`major`:e.some(e=>/feat(\(.*?\))?:/.test(e.message))?`minor`:`patch`;return o.inc(t,n)??(()=>{throw Error(`Failed to increment version '${t}' with release type '${n}'`)})()},u=async()=>{let e=a({input:process.stdin,output:process.stdout});return await new Promise(t=>{e.question(`Press Enter to continue ('s' to skip): `,n=>{e.close(),t(n.trim()!==`s`)})})},d=e=>{let t=/^\/(.+)\/(\w*)$/.exec(e);return t?new RegExp(t[1],t[2]):new RegExp(e)},f=[`context`,`bump`,`commit`,`tag`],p={file:[`package.json`,`Cargo.toml`],pattern:/(\bversion\b.*?)\d[\w.+-]*/,replacement:`$1{{newVersion}}`},m=[`package.json`,`Cargo.toml`],h={flow:f,newVersion:``,bump:m,contextFile:`RELEASE.md`,commitMessage:`chore(release): {{tag}}`,tagPrefix:`v`,dryRun:!1},g=async(e,t,r,i,a)=>{if(console.log(`\nAbout to write context to '${e.contextFile}'`),!await u()||e.dryRun)return;let o=``,s=`---\nversion: ${e.newVersion}\ntag: ${i}\ndate: ${new Date().toLocaleString(`en-US`,{month:`short`,day:`numeric`,year:`numeric`})}\nprevTag: ${r}\nrepoURL: ${a}
2
2
  ---
3
3
  `;o+=s+`
4
- `;let l=n.map(e=>`[${e.hash}] ${e.message}`).join(`\n${`-`.repeat(30)}\n`);o+=`## Commit Log\n\n\`\`\`\n${l}\n\`\`\``,t(e.contextFile,o,`utf8`)},m=async n=>{let r=n.bump.map(e=>typeof e==`string`?{...d,file:e}:e);console.log(`\nAbout to bump versions in files: ${r.map(e=>[e.file].flat()).flat().join(`, `)}`),await c()&&r.forEach(r=>{typeof r.pattern==`string`&&(r.pattern=l(r.pattern)),[r.file].flat().forEach(i=>{let a=e(i,`utf8`).replace(r.pattern,r.replacement.replace(`{{newVersion}}`,n.newVersion));n.dryRun||t(i,a,`utf8`)})})},h=async e=>{let t=`git commit -m "${e.commitMessage}"`;console.log(`\nAbout to commit changes: '${t}'`),await c()&&(e.dryRun||n(t,{stdio:`inherit`}))},g=async(e,t,r)=>{let i=`git tag ${r} -m "${e.commitMessage}"`,a=RegExp(`^${e.commitMessage.replace(r,t).replace(/[()]/g,`\\$&`)}$`),o=n(`git log -1 --format=%s`,{encoding:`utf8`}).trim(),s=``;a.test(o)&&(s+=`
5
- Latest commit is a release commit. Reusing the latest tag.`,i=`git tag ${t} -m "${o}" -f`),s+=`\nAbout to create a tag: '${i}'`,console.log(s),await c()&&(e.dryRun||n(i,{stdio:`inherit`}))};var _=async t=>{let n=JSON.parse(e(`package.json`,`utf8`));t={...n.relion,...t};let i={...f,...t};console.log(`-`.repeat(30)),!t.tagPrefix&&n.name.startsWith(`@`)&&(i.tagPrefix=`${n.name}@`);let a=n.version;console.log(`Current version: ${a}`);let c=r(`git`,[`describe`,`--match`,`${i.tagPrefix}[0-9]*.[0-9]*.[0-9]*`,`--abbrev=0`],{encoding:`utf8`}).stdout.trim();console.log(`Current tag: ${c}`);let l=o(c);console.log(`Parsed commits: ${l.length}`),i.newVersion||=s(l,a),console.log(`New version: ${i.newVersion}`);let d=`${i.tagPrefix}${i.newVersion}`;console.log(`New tag: ${d}`),i.commitMessage=i.commitMessage.replace(`{{tag}}`,d),console.log(`Commit message: '${i.commitMessage}'`);let _=n.repository;console.log(`Repo URL: ${_}`),console.log(`-`.repeat(30));for(let e of u.filter(e=>i.flow.includes(e)))await{context:()=>p(i,l,c,d,_),bump:()=>m(i),commit:()=>h(i),tag:()=>g(i,c,d)}[e]()};const v=e=>e;export{_ as default,v as defineConfig};
4
+ `;let c=t.map(e=>`[${e.hash}] ${e.message}`).join(`\n${`-`.repeat(30)}\n`);o+=`## Commit Log\n\n\`\`\`\n${c}\n\`\`\``,n(e.contextFile,o,`utf8`)},_=async r=>{let i=r.bump.map(e=>typeof e==`string`?{...p,file:e}:e).filter(t=>[t.file].flat().every(t=>e(t)));console.log(`\nAbout to bump versions in files: ${i.map(e=>[e.file].flat()).flat().join(`, `)}`),await u()&&i.forEach(e=>{typeof e.pattern==`string`&&(e.pattern=d(e.pattern)),[e.file].flat().forEach(i=>{let a=t(i,`utf8`).replace(e.pattern,e.replacement.replace(`{{newVersion}}`,r.newVersion));r.dryRun||n(i,a,`utf8`)})})},v=async e=>{let t=`git commit -m "${e.commitMessage}"`;console.log(`\nAbout to commit changes: '${t}'`),await u()&&(e.dryRun||r(t,{stdio:`inherit`}))},y=async(e,t,n)=>{let i=`git tag ${n} -m "${e.commitMessage}"`,a=RegExp(`^${e.commitMessage.replace(n,t).replace(/[()]/g,`\\$&`)}$`),o=r(`git log -1 --format=%s`,{encoding:`utf8`}).trim(),s=``;a.test(o)&&(s+=`
5
+ Latest commit is a release commit. Reusing the latest tag.`,i=`git tag ${t} -m "${o}" -f`),s+=`\nAbout to create a tag: '${i}'`,console.log(s),await u()&&(e.dryRun||r(i,{stdio:`inherit`}))};async function b(t){if(t?.manifest&&!e(t.manifest))throw Error(`Specified manifest file '${t.manifest}' does not exist`);let n=t?.manifest??m.find(e);if(!n)throw Error(`No manifest file found, please specify one`);console.log(`-`.repeat(30)),console.log(`Manifest file: ${n}`);let r=s(n);t={...r.relion,...t};let a={...h,...t};!t.tagPrefix&&r.name.startsWith(`@`)&&(a.tagPrefix=`${r.name}@`);let o=r.version;console.log(`Current version: ${o}`);let u=i(`git`,[`describe`,`--match`,`${a.tagPrefix}[0-9]*.[0-9]*.[0-9]*`,`--abbrev=0`],{encoding:`utf8`}).stdout.trim();console.log(`Current tag: ${u}`);let d=c(u);console.log(`Parsed commits: ${d.length}`),a.newVersion||=l(d,o),console.log(`New version: ${a.newVersion}`);let p=`${a.tagPrefix}${a.newVersion}`;console.log(`New tag: ${p}`),a.commitMessage=a.commitMessage.replace(`{{tag}}`,p),console.log(`Commit message: '${a.commitMessage}'`);let b=r.repository;console.log(`Repo URL: ${b}`),console.log(`-`.repeat(30));for(let e of f.filter(e=>a.flow.includes(e)))await{context:()=>g(a,d,u,p,b),bump:()=>_(a),commit:()=>v(a),tag:()=>y(a,u,p)}[e]()}const x=e=>e;export{b as default,x as defineConfig};
package/package.json CHANGED
@@ -1,47 +1,35 @@
1
1
  {
2
- "name": "relion",
3
- "version": "0.40.0",
4
- "description": "🔖 Modern Release Workflow Helper",
5
- "author": "kh4f <kh4f.dev@gmail.com>",
6
- "license": "MIT",
7
- "repository": "https://github.com/kh4f/relion",
8
- "bugs": "https://github.com/kh4f/relion/issues",
9
- "homepage": "https://github.com/kh4f/relion#readme",
10
- "keywords": [
11
- "relion",
12
- "release",
13
- "release-automation",
14
- "release-workflow",
15
- "release-helper",
16
- "release-workflow-helper"
17
- ],
18
- "files": [
19
- "dist"
20
- ],
21
- "type": "module",
22
- "main": "dist/index.js",
23
- "bin": "dist/cli.js",
24
- "types": "dist/index.d.ts",
25
- "dependencies": {
26
- "semver": "^7.7.4"
27
- },
28
- "devDependencies": {
29
- "@eslint/js": "^10.0.1",
30
- "@stylistic/eslint-plugin": "^5.9.0",
31
- "@types/node": "^25.3.0",
32
- "@types/semver": "^7.7.1",
33
- "eslint": "^10.0.2",
34
- "jiti": "^2.6.1",
35
- "tsdown": "^0.20.3",
36
- "tsx": "^4.21.0",
37
- "typescript": "^5.9.3",
38
- "typescript-eslint": "^8.56.1"
39
- },
40
- "scripts": {
41
- "build": "tsdown",
42
- "build:watch": "tsdown --watch",
43
- "build:prod": "tsdown --prod",
44
- "lint": "eslint",
45
- "release": "tsx src/cli"
46
- }
2
+ "name": "relion",
3
+ "version": "0.41.1",
4
+ "description": "🏷️ Modern Release Workflow Helper",
5
+ "author": "kh4f <kh4f.dev@gmail.com>",
6
+ "license": "MIT",
7
+ "repository": "https://github.com/kh4f/relion",
8
+ "bugs": "https://github.com/kh4f/relion/issues",
9
+ "homepage": "https://github.com/kh4f/relion#readme",
10
+ "keywords": ["relion", "release", "release-automation", "release-workflow", "release-helper", "release-workflow-helper"],
11
+ "files": ["dist"],
12
+ "type": "module",
13
+ "main": "dist/index.js",
14
+ "bin": "dist/cli.js",
15
+ "types": "dist/index.d.ts",
16
+ "scripts": {
17
+ "build": "tsdown",
18
+ "build:watch": "tsdown --watch",
19
+ "build:prod": "tsdown --prod",
20
+ "lint": "eslint",
21
+ "release": "bun src/cli"
22
+ },
23
+ "dependencies": { "semver": "^7.7.4" },
24
+ "devDependencies": {
25
+ "@eslint/js": "^10.0.1",
26
+ "@stylistic/eslint-plugin": "^5.9.0",
27
+ "@types/node": "^25.3.3",
28
+ "@types/semver": "^7.7.1",
29
+ "eslint": "^10.0.2",
30
+ "jiti": "^2.6.1",
31
+ "tsdown": "^0.20.3",
32
+ "typescript": "^5.9.3",
33
+ "typescript-eslint": "^8.56.1"
34
+ }
47
35
  }