Release channels
The package is published to npm as @circle-rd/auth-ai under the MIT license, with public access and npm provenance.
Channels
| Channel | Trigger | npm dist-tag | Install |
|---|---|---|---|
nightly | A manual run of the Nightly workflow, from develop or main. | nightly | npm install @circle-rd/auth-ai@nightly |
latest | Creating a GitHub release vX.Y.Z from main. | latest | npm install @circle-rd/auth-ai |
next | Creating a GitHub release marked pre-release (X.Y.Z-rc.1). | next | npm install @circle-rd/auth-ai@next |
Nightly
A nightly is published as X.Y.Z-nightly.<date>.g<sha> (for example 0.1.1-nightly.20261101.g1a2b3c4), where <date> is the UTC date and <sha> the short commit. X.Y.Z is the version in package.json, or the next patch when that version is already on npm, so a nightly never sorts before a stable release. The version exists only in the workflow's workspace: no commit is made, so no version-bump lands on the branch. No GitHub release is created for a nightly, and old nightlies are not deprecated automatically (that needs a token; Trusted Publishing covers publishing only).
Use a nightly to try an unreleased change. Nothing about its API is guaranteed.
Latest
The release is the trigger: create the GitHub release (and its tag vX.Y.Z) from main. The workflow never creates a release or a tag itself. It:
- runs the same quality gates as continuous integration (type-check, lint, format check, unit tests with a coverage threshold, build, and an audit of production dependencies);
- requires that the tag matches the version in
package.json, that the pre-release flag matches the version (a-suffix means pre-release), and that a stable release points at a commit onmain; - builds and publishes with the
latest(ornext) dist-tag and provenance.
If a run fails, fix the cause, then delete the release and its tag and create them again. Re-running a job of a deleted tag fails at checkout.
Authentication to npm
Both workflows publish through npm Trusted Publishing (OIDC): no npm token is stored in the repository. Each workflow file (release.yml, nightly.yml) must be registered as a trusted publisher of the package on npmjs.com, with the npm publish action allowed.
Versioning
The project follows Semantic Versioning. While the major version is 0, a breaking change bumps the minor version. Breaking changes are listed in the changelog.
Peer dependencies
fastify (>=5.12.6), react (>=18) and vue (>=3.4) are optional peer dependencies. Node.js >=22 is required.