Skip to content
ContractSpec
Start here
AI index

Package distribution

Public Core, private full fleet

The full @lssm-tech/* fleet is distributed through GitHub Packages with restricted access. A fixed, dependency-closed ContractSpec Core and Delivery surface is also mirrored to public npmjs for external adoption. Registry presence is qualified from exact tarball evidence; workspace source alone never claims availability.

1) Install the public closure

Qualified public packages need no GitHub token or private scope configuration. Pin exact versions in production and verify the recorded tarball integrity.

bash
pnpm add -E @lssm-tech/lib.schema @lssm-tech/lib.contracts-spec
pnpm add -D -E @lssm-tech/app.cli-contractspec

2) Request private access

For packages outside the public closure, contact the ContractSpec team with your GitHub username or organization, the consuming repository, and whether access is for a person, CI bot, or GitHub App. Consumers normally need read-only package access; release automation is the only path that needs package write access.

3) Configure private registry auth

Export a token that can read the private packages. Keep real token values out of source control, examples, issue comments, and logs.

bash
export GITHUB_PACKAGES_TOKEN=<token-with-read-package-access>
text
@lssm-tech:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GITHUB_PACKAGES_TOKEN}
text
[install.scopes]
"@lssm-tech" = { token = "$GITHUB_PACKAGES_TOKEN", url = "https://npm.pkg.github.com" }

4) Use ContractSpec GitHub Actions

External repositories can still call ContractSpec actions. Pass a token with private package read access when the action needs to install or execute ContractSpec packages. The caller repository's github.token works only after that repository has package access.

yaml
permissions:
  contents: read
  packages: read

jobs:
  contractspec:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: lssm-tech/contractspec/packages/apps/action-pr@main
        with:
          github-packages-token: ${{ secrets.CONTRACTSPEC_PACKAGES_TOKEN }}
          generate-command: 'bun contractspec generate'

Maintainer CI/CD boundary

Maintainer workflows publish the full scoped fleet to https://npm.pkg.github.com. Manual public adoption runs may target only the governed closure, reuse immutable prebuilt bytes, and require exact-head quality plus signed Connect promotion evidence.