Deployment & CI Spec

Status: ✅ Done (updated 2026-05-08)

npm Package

Binary name: codacy (registered in package.json under bin)
Included files: dist/ and README.md (via files field)
Pre-publish: prepublishOnly runs npm run update-api && npm run build as a safety net for local publishes
Engines: requires Node.js >= 20
Install globally: npm install -g "@codacy/codacy-cloud-cli"

Triggers on: push and pull requests to main.

Matrix: Node.js 18, 20, 22.

Jobs:

build-and-test: checkout → setup node → install → generate API client → type check → build → test
changeset-check (PRs only): verifies at least one .changeset/*.md file is present in the PR diff

Triggers on: push to main.

Uses the changesets/action to automate versioning and publishing.

Steps:

Checkout
Setup Node with registry-url: https://registry.npmjs.org
npm ci
Generate API client (npm run update-api)
Build (npm run build)
Test (npm test)
changesets/action — either:
- Creates/updates a "chore: version packages" PR (bumps version, updates CHANGELOG.md)
- If that PR was just merged, runs changeset publish to publish to npm with provenance

Planned for future distribution as a separate brew formula for macOS/Linux/Windows. No implementation yet.

Secret	Used by
`NPM_TOKEN`	Release workflow (`NODE_AUTH_TOKEN` for npm publish)
`CODACY_API_TOKEN`	CLI runtime (env var, not a secret in CI)