Files
playkit/docs/NPM_REGISTRY.md
T
ilia 84393be785
CI / release (pull_request) Has been skipped
CI / skip-ci-check (pull_request) Successful in 4s
CI / secret-scan (pull_request) Successful in 4s
CI / build-and-test (pull_request) Successful in 23s
CI / selftest (pull_request) Successful in 27s
Close playkit ops gap: require npm publish, mark Outline/npm done.
Remove release soft-fail now that NPM_PUBLISH_TOKEN works; refresh OPS/OUTLINE/ROADMAP for the live Outline doc and published 0.4.0 registry package.
2026-07-15 11:06:20 -04:00

52 lines
1.2 KiB
Markdown

# Gitea npm registry (@levkin scope)
Gitea Package Registry is enabled on `git.levkin.ca`. Playkit releases can be
installed without a git URL once published.
## Consumer install
`.npmrc` (or CI step):
```ini
@levkin:registry=https://git.levkin.ca/api/packages/ilia/npm/
//git.levkin.ca/api/packages/ilia/npm/:_authToken=${PLAYKIT_GIT_TOKEN}
```
```bash
npm i @levkin/playkit
# or pin: npm i @levkin/playkit@0.4.0
```
Git pin remains supported as a fallback:
```bash
npm i git+https://git.levkin.ca/ilia/playkit.git#v0.4.0
```
## Publish (release job)
On `vX.Y.Z` tag, `.gitea/workflows/ci.yml` `release` job:
1. Creates the Gitea Release + attaches `npm pack` tarball
2. Runs `npm publish` to `https://git.levkin.ca/api/packages/ilia/npm/`
using `NPM_PUBLISH_TOKEN` if set, else `RELEASE_TOKEN`
(needs **`write:package`**)
Manual one-shot:
```bash
NPM_PUBLISH_TOKEN=… ./scripts/publish-gitea-npm.sh
```
## Verify
```bash
npm view @levkin/playkit versions --registry https://git.levkin.ca/api/packages/ilia/npm/
```
## Token setup
`@levkin/playkit@0.4.0` is on the registry. Tag/CI publish uses Actions secret
`NPM_PUBLISH_TOKEN` (`write:package`). Local ops: vault
`vault_playkit_npm_token` / `./scripts/publish-gitea-npm.sh`. See **`docs/OPS.md`**.