@fantastic.dev/repo-gates 0.2.2 → 0.2.3

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.
Files changed (2) hide show
  1. package/README.md +33 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -522,6 +522,39 @@ pnpm run typecheck # tsc --noEmit
522
522
  pnpm run build # tsup → dist/ (esm + d.ts)
523
523
  ```
524
524
 
525
+ ## Releases
526
+
527
+ [Release Please](https://github.com/googleapis/release-please-action) maintains a
528
+ release PR after changes merge into `main`. It updates `package.json`,
529
+ `CHANGELOG.md`, and `.release-please-manifest.json`. Review and merge that PR to
530
+ create the version tag and GitHub release and publish to npm with trusted
531
+ publishing. No direct push to `main` or npm token is needed.
532
+
533
+ Use Conventional Commit titles for squash-merged PRs:
534
+
535
+ | Title prefix | Version change |
536
+ | --- | --- |
537
+ | `fix:`, `docs:`, `perf:` | Patch |
538
+ | `chore:`, `ci:`, `build:`, `refactor:`, `test:`, `revert:` | Patch |
539
+ | `feat:` | Minor |
540
+ | A `!` suffix, such as `feat!:`, or a `BREAKING CHANGE:` footer | Major, including before 1.0 |
541
+
542
+ Edit `release-please-config.json` to change release policy. The manifest records
543
+ the last released version; let the release PR update it. Do not manually bump
544
+ versions for normal changes. Non-conventional titles may be omitted from releases.
545
+
546
+ The workflow explicitly dispatches CI for bot-created release PRs because
547
+ GitHub's built-in token does not trigger their normal PR workflows. Publishing
548
+ runs in the same `release.yml` workflow after release creation, rather than
549
+ waiting for a bot-created tag to trigger another run. Release PRs are not
550
+ automatically merged; merging one is the release decision.
551
+
552
+ If publishing fails after the GitHub release is created, use **Re-run failed
553
+ jobs** on that Release run to retain its release outputs. Check npm first if the
554
+ publish result is uncertain; published versions cannot be overwritten. Manual
555
+ `v*` tags remain supported and must match `package.json`. Keep the workflow named
556
+ `release.yml`, since npm's trusted-publisher configuration uses that filename.
557
+
525
558
  ## License
526
559
 
527
560
  [MIT](./LICENSE) © Kelly Kampen
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fantastic.dev/repo-gates",
3
- "version": "0.2.2",
3
+ "version": "0.2.3",
4
4
  "description": "Config-driven repo quality gates for turborepo (and any) monorepos: a quiet check:all orchestrator, CI-parity drift detector, a PR docs-coverage gate, and ratchet guards (file size, debt markers, circular imports, secrets, coverage, bundle size). The engine is repo-agnostic; policy lives in the consumer repo's config.",
5
5
  "keywords": [
6
6
  "turborepo",