@githonllc/avouch 0.1.0 → 0.1.1
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 +15 -28
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -121,46 +121,33 @@ Exit code 0 means there is a result. 1 means there is no result: the id is not d
|
|
|
121
121
|
|
|
122
122
|
This repository is also a Claude Code plugin marketplace. Install the plugin:
|
|
123
123
|
|
|
124
|
-
```
|
|
125
|
-
|
|
124
|
+
```sh
|
|
125
|
+
claude plugin marketplace add githonllc/avouch
|
|
126
|
+
claude plugin install avouch@avouch
|
|
126
127
|
```
|
|
127
128
|
|
|
129
|
+
Inside a Claude Code session, the same two steps are `/plugin marketplace add githonllc/avouch` and `/plugin install avouch@avouch`.
|
|
130
|
+
|
|
128
131
|
The plugin has two skills:
|
|
129
132
|
- `avouch-cli`: checks an ontology and runs `avouch query`.
|
|
130
133
|
- `aquery-scan` (also `/aquery-scan [project-dir]`): drafts or updates a project's ontology from its design documents. The result is a candidate. `avouch check` must exit 0, and each source gap is listed with a proposed fix to the document.
|
|
131
134
|
|
|
132
|
-
The skills run the CLI with `npx -y
|
|
135
|
+
The skills run the CLI with `npx -y @githonllc/avouch@<version>`, pinned to the version of this repository. Set `AVOUCH_CLI` to a built `dist/cli/avouch.js` to use a local build instead. The `prepare` script builds `dist/` when npm installs the package from git (`npx -y github:githonllc/avouch`). `skills/aquery-scan/fixture/` is the test project for the skill.
|
|
133
136
|
|
|
134
137
|
## Publishing
|
|
135
138
|
|
|
136
|
-
The npm package is `@githonllc/avouch`, and its command is `avouch`. `package.json` has `"private": true` in the repository, so an accidental `npm publish` from a working copy is refused.
|
|
137
|
-
|
|
138
|
-
A release needs the explicit approval of the project owner. Do these steps in this sequence:
|
|
139
|
+
The npm package is `@githonllc/avouch`, and its command is `avouch`. `package.json` has `"private": true` in the repository, so an accidental `npm publish` from a working copy is refused. The release workflow removes that line only in its own checkout.
|
|
139
140
|
|
|
140
|
-
|
|
141
|
-
2. Make a release copy in an empty directory outside every git worktree, and check it:
|
|
141
|
+
A release needs the explicit approval of the project owner. Releases are published by the GitHub Actions workflow `.github/workflows/release.yml` through npm trusted publishing: no npm token is stored, and npm adds provenance. Do these steps in this sequence:
|
|
142
142
|
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
Every command must exit with code 0. Keep the file list that `npm pack --dry-run` prints.
|
|
150
|
-
3. Give the owner the commit, the test result and the file list. Continue only after the owner approves this release.
|
|
151
|
-
4. Sign in to npm as a member of the `githonllc` organization, with two-factor authentication (`npm whoami` shows the account). Then publish from the release copy:
|
|
152
|
-
|
|
153
|
-
```sh
|
|
154
|
-
npm pkg delete private
|
|
155
|
-
npm publish --dry-run --access public
|
|
156
|
-
npm publish --access public
|
|
157
|
-
```
|
|
158
|
-
|
|
159
|
-
The dry-run file list must be the same as the list from step 2. A scoped package needs `--access public`, or npm publishes it as restricted. `npm publish` runs `prepack`, which builds `dist/`.
|
|
160
|
-
5. Make sure that the release works:
|
|
161
|
-
- `npm view @githonllc/avouch version` shows the new version;
|
|
143
|
+
1. Set the new `0.x` version in `package.json`, `.claude-plugin/plugin.json` and the `npx -y @githonllc/avouch@<version>` pins in `skills/*/SKILL.md`, merge it to `main`, and wait for CI to pass. Check the file list that the CI step `npm pack --dry-run` prints.
|
|
144
|
+
2. Tag the merge commit `v<version>` (the same version as `package.json`) and push the tag. The workflow checks that the tag matches the version, runs `npm ci`, the type check and the tests, removes `"private"`, and publishes with `--access public`.
|
|
145
|
+
3. The job waits in the `npm` environment until the owner approves it in GitHub. The owner's approval is the release approval.
|
|
146
|
+
4. Make sure that the release works:
|
|
147
|
+
- `npm view @githonllc/avouch version` shows the new version (a new version can take a few minutes to become available);
|
|
162
148
|
- in an empty directory, `npx -y @githonllc/avouch@<version> check` prints the usage line and exits with code 2.
|
|
163
|
-
|
|
149
|
+
|
|
150
|
+
Version 0.1.0 was published by hand, because npm accepts a trusted publisher only for a package that exists.
|
|
164
151
|
|
|
165
152
|
## Versions and identifiers
|
|
166
153
|
|