agents-md-kit 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 -1
- package/bin/agent-kit.js +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -90,12 +90,13 @@ Verified on 2026-11-11 (Windows 11, Node 22.18, npm 11.19, Python 3.13):
|
|
|
90
90
|
- **node-backend:** the same commitlint/husky checks pass. ESLint catches planted errors in a TypeScript sample.
|
|
91
91
|
- **python:** `ruff check`, `ruff format --check`, `pytest` and `mypy` pass on a sample. pre-commit rejects a bad commit message, accepts a good one and blocks a staged Ruff error.
|
|
92
92
|
- **Clean install:** every preset installs, validates, and re-installs as a no-op.
|
|
93
|
+
- **From the npm registry:** `npx agents-md-kit` (v0.1.0) lists the units, installs the `python` preset with the `github` pack, validates, and a second `--apply` writes nothing.
|
|
93
94
|
|
|
94
95
|
**Untested:**
|
|
95
96
|
- GitHub Actions workflows (`ci.yml`, `pr-title.yml`, `release-please.yml`), Dependabot configs and release-please behavior. They parse (light check only for YAML) but have never run. The pinned action majors (`actions/checkout@v4`, `setup-node@v4`, `setup-python@v5`, `release-please-action@v4`, `action-semantic-pull-request@v5`) are behind the latest majors. Dependabot will propose updates; review their changelogs before merging.
|
|
96
97
|
- Node 20 (only Node 22 was run).
|
|
97
98
|
- macOS and Linux. Setting the exec bit and refusing file symlinks were exercised only through simulation and Windows junctions.
|
|
98
|
-
- pnpm/yarn variants
|
|
99
|
+
- pnpm/yarn variants.
|
|
99
100
|
|
|
100
101
|
`.claude/settings.json` deny rules use the documented `Bash(cmd *)` and `Read(./path)` forms (checked against the Claude Code permissions docs on 2026-11-11). Prefix deny rules are a guard rail, not a sandbox: a reordered command (`git push origin main --force`) is not matched.
|
|
101
102
|
|
|
@@ -132,6 +133,19 @@ npm run check # type-check, tests and template validation
|
|
|
132
133
|
|
|
133
134
|
The source is plain JavaScript with JSDoc types, checked by `tsc --noEmit`. There is no build step: the files in `src/` are the files that ship.
|
|
134
135
|
|
|
136
|
+
### Releasing
|
|
137
|
+
|
|
138
|
+
Releases are published from GitHub Actions with npm trusted publishing: no npm token is stored, and the run authenticates over OIDC. One-time setup, on npmjs.com under the package's Settings > Trusted Publisher > GitHub Actions: user `Rumpz`, repository `agents-md-kit`, workflow filename `publish.yml`, no environment. (A new trusted-publisher entry expires unless its first publish succeeds within 2 days.)
|
|
139
|
+
|
|
140
|
+
Then, for each release:
|
|
141
|
+
|
|
142
|
+
```bash
|
|
143
|
+
npm version patch # or minor / major; bumps package.json and creates the vX.Y.Z tag
|
|
144
|
+
git push --follow-tags
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
`.github/workflows/publish.yml` runs type-check, tests and template validation, checks the tag matches `package.json`, and publishes. To rehearse everything except the upload, run the workflow by hand from the Actions tab (it ends in `npm publish --dry-run`). That only passes when `package.json` holds a version that isn't on npm yet, so bump it first (`npm version patch --no-git-tag-version`, commit and push); on an already-published version it stops with "You cannot publish over the previously published versions".
|
|
148
|
+
|
|
135
149
|
Installed files keep the short `agent-kit` name in two places: the managed-block markers (`agent-kit:<id>`) and the `docs/agent-kit/` folder.
|
|
136
150
|
|
|
137
151
|
## How this kit was built
|
package/bin/agent-kit.js
CHANGED
|
File without changes
|
package/package.json
CHANGED