alexion
ed87f023cb
Complete the distribution metadata and publish flow for the unscoped `gitea-axi` package: - add `repository`, `homepage`, and `bugs` to package.json - add `publishConfig` (public access, npmjs registry) so `npm publish` needs no extra flags - replace `prepublishOnly` with `prepack: npm run build`, so both `npm pack` and `npm publish` rebuild `dist/` first - document the single-command flow in PUBLISHING.md - add a packaging smoke-test tier (`test:pack`) that packs the real tarball, installs it globally, and drives the installed binary (`--help`, dashboard header, and `setup` finding the bundled skill)
39 lines
1.9 KiB
Markdown
39 lines
1.9 KiB
Markdown
# Publishing gitea-axi
|
|
|
|
`gitea-axi` is an unscoped, public npm package.
|
|
Publishing it is a single command.
|
|
|
|
## Release
|
|
|
|
```sh
|
|
npm publish
|
|
```
|
|
|
|
That is the whole flow.
|
|
Everything the release needs is wired into `package.json`, so no extra flags are required:
|
|
|
|
- The `prepack` script runs `npm run build`, so the tarball always carries a freshly compiled `dist/` rather than whatever happened to be on disk.
|
|
- `publishConfig.access` is `public`, so the unscoped package publishes publicly without `--access public`.
|
|
- `publishConfig.registry` targets the public npm registry (`https://registry.npmjs.org/`), so a machine whose default registry is set elsewhere still publishes to the right place.
|
|
- The `files` allowlist ships only `dist/` and `skills/`, so the built CLI and the bundled Agent Skill go out and nothing else does.
|
|
|
|
There is deliberately no `postinstall` script.
|
|
Installing the package delivers the `gitea-axi` binary only; installing the Agent Skill and the session hooks stays an explicit user action behind `gitea-axi setup` and `gitea-axi setup hooks`.
|
|
|
|
## Before publishing
|
|
|
|
You need to be authenticated to the npm registry (`npm whoami` to check, `npm login` if not) with publish rights to the `gitea-axi` name.
|
|
|
|
Bump the version first with `npm version <patch|minor|major>`, which updates `package.json` and creates the release commit and tag.
|
|
|
|
## Verifying the packed artifact
|
|
|
|
The packaging smoke test packs the real tarball, installs it globally into a throwaway prefix, and drives the installed binary — `--help`, the dashboard header, and `setup` finding the bundled skill:
|
|
|
|
```sh
|
|
npm run test:pack
|
|
```
|
|
|
|
It builds, packs, and fetches the runtime dependencies from the registry, so it is slower than the unit and integration tiers and is not part of the default `npm test` run.
|
|
Distribution touches no Gitea API, so this smoke test is the distribution analogue of the live-Gitea end-to-end tier.
|