https://github.com/kh4f/relion
🔖 Modern Release Workflow Helper
https://github.com/kh4f/relion
release release-automation release-helper release-workflow release-workflow-helper relion
Last synced: about 2 months ago
JSON representation
🔖 Modern Release Workflow Helper
- Host: GitHub
- URL: https://github.com/kh4f/relion
- Owner: kh4f
- License: mit
- Created: 2025-05-17T01:08:07.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-14T16:29:44.000Z (5 months ago)
- Last Synced: 2026-01-14T19:44:31.158Z (5 months ago)
- Topics: release, release-automation, release-helper, release-workflow, release-workflow-helper, relion
- Language: TypeScript
- Homepage: https://npmjs.com/package/relion
- Size: 1.41 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
A zero‑config npm lib for automating the release workflow:
version bumping, release commit & tag creation, and AI‑assisted changelog generation
Usage •
Release Workflow •
Changelog Generation
## 🕹️ Usage
```bash
$ bunx relion -h
Options:
-b Files to bump the version in ['package.json']
-v Release version [calculated from commits]
-t Tag prefix [v]
-d Dry run [false]
-y Skip prompts [false]
Examples:
bunx relion -b src/manifest.json Bump a custom file
bunx relion -d -v 1.2.3 Dry run with a custom version
```
- `package.json` is **always included** in the bump list if exists
- to create a tag without a prefix, use `-t ''`
Example output of running bunx relion:
```
Project: relion
Repo: github.com/kh4f/relion
Current tag: v0.42.1
Current version: 0.42.1
Parsed commits: 26
New version: 0.43.0
New tag: v0.43.0
------------------------------
('' to continue / 's' to skip)
About to write context to 'RELEASE.md'
About to bump version in files: package.json
About to commit changes: 'git commit -m "chore(release): v0.43.0"'
About to create a tag: 'git tag v0.43.0 -m "chore(release): v0.43.0"'
```
## ♻️ Release Workflow
1. **Context**: generates a `RELEASE.md` file with upcoming release metadata and commit log
The log is [automatically filtered](tests/context.test.ts) to exclude non-user-facing commits.
2. **Bump**: updates version in specified files
Most files are bumped with a [generic pattern](https://regex101.com/r/t570Gh/1); `.rc` files use a dedicated one.
3. **Commit**: creates a release commit
Changes are **not staged automatically** before committing, unless `-y` is passed.
4. **Tag**: creates an annotated release tag
Generated release context example (*):
```markdown
---
tag: v0.33.0
prevTag: v0.32.1
date: Jan 10, 2026
repoURL: github.com/kh4f/relion
---
## Commit Log
[8f29acf] fix(versioner): ensure breaking changes take priority over features in release type calculation
Previously, if commits contained both features and breaking changes, features would be checked last and could incorrectly override the 'major' release type with 'minor'.
------------------------------
[e105d51] feat(config-merger): add `mergeConfigs` implementation and export
- Implement `mergeConfigs` to support merging config profiles in `config-merger.ts`
- Export `mergeConfigs` from `src/index.ts`
```
## 📋 Changelog Generation
Relion doesn’t format the changelog itself. Instead, it generates a `RELEASE.md` file with release metadata and commit log, and provides a [`generate-changelog`](skills/generate-changelog/SKILL.md) skill to turn that context into a polished changelog entry with AI.
Recommended workflow:
1. Install the skill: `bunx skills add kh4f/relion [-g]`
(see the [`skills` CLI docs](https://www.npmjs.com/package/skills))
2. Run Relion to generate `RELEASE.md`
3. Review the generated release context
4. Ask your AI agent to generate a changelog
Generated changelog example (from the (*) release context; Gemini 3 Pro)
```markdown
## [` 📦 v0.33.0 `](https://github.com/kh4f/relion/compare/v0.32.1...v0.33.0)
### 🎁 Features
- **Config merging utility**: added `mergeConfigs` implementation to support merging config profiles. [🡥](https://github.com/kh4f/relion/commit/e105d51)
### 🩹 Fixes
- **Correct release type calculation**: breaking changes now correctly take priority over features when determining the release type, preventing incorrect minor bumps. [🡥](https://github.com/kh4f/relion/commit/8f29acf)
##### [Full Changelog](https://github.com/kh4f/relion/compare/v0.32.1...v0.33.0) • Jan 10, 2026
```