brel 0.1.1 → 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,38 @@
+## [unreleased]
+
+### 🚀 Features
+
+- Tag after release
+## [0.1.2] - 2026-02-18
+
+### 🐛 Bug Fixes
+
+- Brel release resolution
+
+### 💼 Other
+
+- Git cliff & changelog
+- Changelog generation
+
+### ⚙️ Miscellaneous Tasks
+
+- *(release)* V0.1.2
+## [0.1.1] - 2026-02-17
+
+### 💼 Other
+
+- Npm publish
+- Musl
+
+### ⚙️ Miscellaneous Tasks
+
+- 0.1.1 patch
+## [0.1.0] - 2026-02-17
+
+### 🚀 Features
+
+- Initial
+
+### 💼 Other
+
+- Dist

package/README.md

@@ -6,6 +6,7 @@
 
 - `brel init` generates a managed GitHub Actions workflow.
 - `brel release-pr` computes the next version, updates configured files, commits, pushes, and creates/updates a release PR.
+- `brel next-version` computes the next releasable version and prints it as plain SemVer.
 
 ## `release-pr` Prerequisites
 
@@ -46,6 +47,14 @@ default_branch = "main"
 release_branch_pattern = "brel/release/v{{version}}"
 pr_template_file = ".github/brel/release-pr-body.hbs"
 
+[release_pr.changelog]
+enabled = true
+output_file = "CHANGELOG.md"
+
+[release_pr.tagging]
+enabled = false
+tag_template = "v{version}"
+
 [release_pr.commit_author]
 name = "brel[bot]"
 email = "brel[bot]@users.noreply.github.com"
@@ -55,7 +64,7 @@ email = "brel[bot]@users.noreply.github.com"
 
 When you run `brel release-pr`:
 
-1. It finds the highest stable SemVer tag (`vX.Y.Z` or `X.Y.Z`).
+1. It finds the highest stable SemVer tag that matches `release_pr.tagging.tag_template` (default `v{version}`).
 2. If no valid tag exists, it uses `0.0.0`.
 3. It scans commits since that tag (or all commits when no tag exists).
 4. It picks one bump level from Conventional Commit signals:
@@ -64,6 +73,11 @@ When you run `brel release-pr`:
    - patch: `fix: ...`
 5. If no releasable commits are found, it exits successfully with no changes.
 
+`brel next-version` uses the same versioning rules:
+
+- when releasable commits exist, it prints the next version (for example `1.2.3`)
+- when none exist, it prints nothing and exits successfully
+
 ## How File Updates Work
 
 - `release_pr.version_updates` maps exact repo-relative file paths to dot-separated key paths.
@@ -82,11 +96,35 @@ Example key paths:
 - JSON: `"package.json" = ["version", "tooling.release.version"]`
 - TOML: `"Cargo.toml" = ["package.version"]`
 
+## Changelog Generation (`git-cliff`)
+
+- `brel init` generates a workflow that runs [`orhun/git-cliff-action@v4`](https://github.com/orhun/git-cliff-action) by default.
+- Configure changelog behavior with `[release_pr.changelog]`:
+  - `enabled` (default `true`)
+  - `output_file` (default `"CHANGELOG.md"`)
+- Generated workflow behavior:
+  - computes `next-version` first via `brel next-version`
+  - runs `git-cliff` only when a next version exists
+  - passes `--unreleased --tag <rendered-tag-template>` so the newest changelog section is versioned instead of `[unreleased]`
+- If changelog generation is enabled, `brel release-pr` stages `output_file` in the release commit when that file exists.
+- Disable changelog generation:
+
+```toml
+[release_pr.changelog]
+enabled = false
+```
+
+- `brel init` does not create or manage `cliff.toml`; keep that file in your repository if you want custom `git-cliff` rules.
+
 ## Branch / Commit / PR Behavior
 
 - Default branch pattern: `brel/release/v{{version}}`
   - Only `{{version}}` is supported as a token.
-- Commit message: `chore(release): vX.Y.Z`
+- `release_pr.tagging.tag_template` controls rendered release tags (default `v{version}`).
+  - `tag_template` accepts `{version}` and legacy `{{version}}` (normalized to `{version}`).
+  - `tag_template` must include exactly one version token.
+- Commit message: `chore(release): <rendered-tag>`
+- PR title: `Release <rendered-tag>`
 - Commit author defaults to:
   - `name = "brel[bot]"`
   - `email = "brel[bot]@users.noreply.github.com"`
@@ -98,6 +136,13 @@ For PRs:
 - If found, it updates that PR (continuity wins over recomputing branch name).
 - If not found, it creates a new PR.
 
+## Tagging on Merge
+
+- Optional config: `[release_pr.tagging] enabled = true` (default `false`).
+- Tag format config: `[release_pr.tagging] tag_template = "v{version}"` (default shown).
+- When enabled, the generated workflow listens for merged pull requests into the configured default branch.
+- If the merged PR is managed by `brel` and titled `Release <rendered-tag>`, the workflow validates it against `tag_template`, then creates and pushes that tag when it does not already exist.
+
 ## PR Body Templates
 
 If `release_pr.pr_template_file` is set, `brel` renders that Handlebars template.
@@ -105,6 +150,7 @@ If `release_pr.pr_template_file` is set, `brel` renders that Handlebars template
 Available variables:
 
 - `version`
+- `tag`
 - `base_branch`
 - `release_branch`
 - `commits` (array of `{ sha_short, subject }`)
@@ -136,3 +182,9 @@ Run with explicit config:
 ```bash
 brel release-pr --config ./configs/release.toml
 ```
+
+Preview the next release version:
+
+```bash
+brel next-version
+```

package/npm-shrinkwrap.json

@@ -23,7 +23,7 @@
       "hasInstallScript": true,
       "license": "MIT",
       "name": "brel",
-      "version": "0.1.1"
+      "version": "0.2.0"
     },
     "node_modules/@isaacs/balanced-match": {
       "engines": {
@@ -515,5 +515,5 @@
     }
   },
   "requires": true,
-  "version": "0.1.1"
+  "version": "0.2.0"
 }

package/package.json

@@ -1,5 +1,5 @@
 {
-  "artifactDownloadUrl": "https://github.com/better-releases/brel/releases/download/0.1.1",
+  "artifactDownloadUrl": "https://github.com/better-releases/brel/releases/download/0.2.0",
   "bin": {
     "brel": "run-brel.js"
   },
@@ -97,7 +97,7 @@
       "zipExt": ".tar.xz"
     }
   },
-  "version": "0.1.1",
+  "version": "0.2.0",
   "volta": {
     "node": "18.14.1",
     "npm": "9.5.0"