chore(ci): harden release pipeline and CLI artifact validation#1
Merged
chore(ci): harden release pipeline and CLI artifact validation#1
Conversation
- switch to atomic semantic-release workflow on main - add release concurrency and npm publish via semantic-release - add built-cli integration tests and quality gate coverage - improve docs for consumer vs repo CLI usage - enforce commitlint via husky commit-msg hook
There was a problem hiding this comment.
Pull request overview
This PR hardens the project’s CI/release pipeline and adds a built-CLI artifact validation step, while expanding end-user usage documentation for the library and CLI.
Changes:
- Add an atomic
semantic-release-driven release workflow (GitHub + npm) with concurrency control. - Introduce built CLI dist integration tests and wire them into the PR quality gate.
- Add commit message enforcement via commitlint + husky, plus new/expanded usage docs.
Reviewed changes
Copilot reviewed 15 out of 17 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
vitest.cli-dist.config.ts |
Adds a dedicated Vitest config for built-CLI dist tests. |
tests/cli/cli.dist.test.ts |
Validates the built CLI’s --help output and unknown-command behavior. |
src/cli/index.ts |
Improves CLI UX with help/suggestions after errors and a help subcommand. |
package.json |
Adds quality, test:cli:dist, semantic-release/commitlint/husky scripts and dev deps; splits Biome lint vs format checking. |
pnpm-lock.yaml |
Locks new dev dependencies (semantic-release, commitlint, husky, etc.). |
docs/usage/cli.md |
Adds CLI reference and invocation modes (consumer vs repo). |
docs/usage/imports.md |
Documents package imports and API surface areas. |
docs/usage/environment.md |
Documents validated env vars and example .env. |
docs/usage/integration-recipes.md |
Adds practical integration workflows/recipes. |
README.md |
Updates quickstart/docs links, clarifies CLI usage, adds commit convention notes. |
commitlint.config.cjs |
Enforces Conventional Commits with a required scope. |
.husky/commit-msg |
Runs commitlint on commit messages via husky hook. |
CHANGELOG.md |
Adds a changelog file for semantic-release to maintain. |
.releaserc.json |
Configures semantic-release plugins (changelog, npm, git, GitHub). |
.github/workflows/release.yml |
Adds main-branch release workflow with quality gate + semantic-release publish. |
.github/workflows/pr-quality.yml |
Adds PR quality workflow running lint/format/typecheck/tests/build/cli-dist tests. |
.gitignore |
Adds .dispatch ignore entry. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
maincommit-msghook (required scope)Key Changes
.github/workflows/pr-quality.yml.github/workflows/release.yml.releaserc.jsonCHANGELOG.mdcommitlint.config.cjs.husky/commit-msgtests/cli/cli.dist.test.tsvitest.cli-dist.config.tspackage.jsonscripts/deps (quality,test:cli:dist,release:dry-run --no-ci)README.mdanddocs/usage/*Validation
pnpm run qualityfeat(cli): add help outputfeat: missing scopepnpm run release:dry-runon feature branch confirms plugin chain loads; no publish occurs offmain