Skip to content

docs: update PUBLISHING.md for trusted-publish (OIDC) flow #112

@mgoldsborough

Description

@mgoldsborough

PUBLISHING.md documents the manual pnpm publish --no-git-checks flow. The repo actually has tag-triggered OIDC publish workflows for all three packages:

  • .github/workflows/schemas-publish.ymlschemas-v*
  • .github/workflows/sdk-typescript-publish.ymlsdk-typescript-v*
  • .github/workflows/sdk-python-publish.ymlsdk-python-v*

All three use id-token: write + environment: npm/pypi for trusted publishing, no local npm/PyPI credentials needed. The doc should reflect this:

cd packages/schemas
npm version minor
git add package.json
git commit -m "release: schemas@$(node -p 'require("./package.json").version)"
git push
git tag schemas-v$(node -p 'require("./package.json").version')
git push --tags
# workflow handles the rest

Drop the pnpm publish --no-git-checks instructions; the workflow's "verify tag matches package.json version" step makes the manual flow strictly more error-prone (version drift between local and CI).

Caught while shipping #100's SDK bumps — manual flow worked but bypassed the audit/verification CI provides.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions