docs: add PUBLISHING.md for npm + PyPI release steps - #8
Merged
Conversation
Documents how to publish the client SDKs: - npm @cloudsecurityalliance/secid (scoped, access:public, tests excluded) - PyPI cloudsecurityalliance-secid (clear dist/ first, build, twine check, upload) - Go (no publish; module-path consumption) Covers prerequisites (npm org membership / PyPI token), the dry-run/check step before each publish, version immutability, lockstep version bumps, and a clean post-publish install verification. Notes that both are first-publishes at 1.0.0 (nothing to deprecate). README links to it from a new Publishing section. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a maintainer-facing
PUBLISHING.mddocumenting how to publish the SecID client SDKs, and links to it from the README.Covers:
@cloudsecurityalliance/secid—npm publish(access:public already in manifest; tests excluded from the tarball).cloudsecurityalliance-secid— cleardist/→python -m build→twine check→twine upload, with a callout to clear stale artifacts first.Validation done while writing this
publish --dry-run: clean, 11 files, no warnings, no test files,access:public.python -m buildproducescloudsecurityalliance_secid-1.0.0sdist+wheel;twine checkPASSED; the wheel installs in a clean venv and thesecidCLI runs.Docs only — no code change.
🤖 Generated with Claude Code