rlsbl 0.45.1 → 0.47.0
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 +5 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -41,7 +41,7 @@ All commands auto-detect registries from project files (`package.json`, `pyproje
|
|
|
41
41
|
| --- | --- |
|
|
42
42
|
| `check` | Run project checks |
|
|
43
43
|
| `status` | Display the current project version, branch, last release tag, unreleased commit count, and changelog coverage. Outputs plain text by default or structured JSON with the --json flag. |
|
|
44
|
-
| `scaffold` | Generate or update CI/CD workflows, git hooks, changelog, and license files
|
|
44
|
+
| `scaffold` | Generate or update CI/CD workflows, git hooks, changelog, and license files. Safe to run repeatedly -- merges template changes with your customizations. Use --force to overwrite all files. |
|
|
45
45
|
| `check-name` | Query npm, PyPI, or other registries to check whether one or more package names are available. Accepts multiple names as positional arguments and respects a configurable delay between checks. |
|
|
46
46
|
| `discover` | Search GitHub for repositories tagged with the rlsbl topic and list them. Use --mine to filter results to only your own repositories. Requires the gh CLI to be authenticated. |
|
|
47
47
|
| `watch` | Poll GitHub Actions CI workflow runs for a specific commit SHA and report pass or fail status. Defaults to HEAD if no SHA is provided. Useful after rlsbl release to monitor the publish pipeline. |
|
|
@@ -118,8 +118,7 @@ Pre-release versions (e.g. `1.0.0-beta.1`) are supported.
|
|
|
118
118
|
## Scaffold
|
|
119
119
|
|
|
120
120
|
```
|
|
121
|
-
rlsbl scaffold # create CI/CD for all detected registries
|
|
122
|
-
rlsbl scaffold --update # three-way merge template updates with user customizations
|
|
121
|
+
rlsbl scaffold # create or update CI/CD for all detected registries
|
|
123
122
|
rlsbl scaffold --force # overwrite managed files (user-owned files still preserved)
|
|
124
123
|
rlsbl scaffold --no-commit # skip auto-commit of scaffolded files
|
|
125
124
|
```
|
|
@@ -139,13 +138,13 @@ Created files are committed automatically by default.
|
|
|
139
138
|
| `.rlsbl/hooks/pre-release.sh` | User-customizable pre-release validation |
|
|
140
139
|
| `.rlsbl/hooks/post-release.sh` | User-customizable post-release actions |
|
|
141
140
|
| `.git/hooks/pre-push` | One-liner: `exec rlsbl pre-push-check "$@"` |
|
|
142
|
-
| `.rlsbl/bases/` | Three-way merge bases for
|
|
141
|
+
| `.rlsbl/bases/` | Three-way merge bases for scaffold |
|
|
143
142
|
|
|
144
|
-
**Three-way merge
|
|
143
|
+
**Three-way merge:** Bases are stored at scaffold time. On re-run, user customizations and template updates merge via `git merge-file`. Conflicts get git-style conflict markers.
|
|
145
144
|
|
|
146
145
|
**User-owned files** (CHANGELOG.md, LICENSE, hooks) are never overwritten, even with `--force`.
|
|
147
146
|
|
|
148
|
-
**Customizing CI without conflicts:** Instead of editing `ci.yml` or `publish.yml` (which can produce merge conflicts on
|
|
147
|
+
**Customizing CI without conflicts:** Instead of editing `ci.yml` or `publish.yml` (which can produce merge conflicts on re-scaffold), put extra jobs in a separate workflow file scaffold never touches:
|
|
149
148
|
|
|
150
149
|
- `.github/workflows/ci-custom.yml` -- runs alongside `ci.yml`
|
|
151
150
|
- `.github/workflows/publish-custom.yml` -- runs alongside `publish.yml`
|