feature/cicd
name: smbcloud-cli-release
description: Use when building, packaging, or releasing smbCloud CLI binaries through npm, PyPI, or GitHub Actions CI/CD. Covers the Rust binary release source of truth, the npm wrapper and platform packages, the PyPI maturin package under pypi/, local publishing with uv tool install maturin, and fixes to .github/workflows/release-npm.yml or .github/workflows/release-pypi.yml.
smbcloud CLI Release
Use this skill when work touches any part of the smbCloud CLI distribution flow:
- local npm release for
smbcloud-cli - local PyPI release for
smbcloud-cli - GitHub Actions npm release automation
- GitHub Actions PyPI release automation
- Rust binary packaging into npm platform packages or PyPI wheels
- release failures caused by macOS cross-compilation, missing package metadata, npm 2FA, or PyPI trusted publishing setup
Source of truth
Use these files as the release source of truth:
- Rust crate version and binary name:
crates/cli/Cargo.toml - npm release workflow:
.github/workflows/release-npm.yml - PyPI release workflow:
.github/workflows/release-pypi.yml - npm platform package generator:
npm/scripts/render-platform-package.cjs - npm wrapper package generator:
npm/scripts/render-main-package.cjs - npm wrapper launcher:
npm/smbcloud-cli/src/index.ts - PyPI package metadata:
pypi/pyproject.toml - PyPI package README:
pypi/README.md
Release model
There are two public distribution channels.
1. npm
npm has two package layers. Publish them in order.
Platform binary packages:
@smbcloud/cli-darwin-arm64@smbcloud/cli-darwin-x64@smbcloud/cli-linux-x64@smbcloud/cli-windows-arm64@smbcloud/cli-windows-x64
Wrapper package:
@smbcloud/cli
The wrapper package resolves the right platform package with require.resolve(...).
Do not publish @smbcloud/cli before the required platform packages for that version exist.
2. PyPI
PyPI uses one package:
smbcloud-cli
It is built from pypi/pyproject.toml with maturin and bindings = "bin", so the published wheel installs the native smb executable directly.
Local npm release workflow
Preflight
- Confirm npm auth with
npm whoami. - Confirm the crate version in
crates/cli/Cargo.toml. - Use the same version string for every npm package in that release.
Build platform binaries
Build each target first:
cargo build --release --locked --target aarch64-apple-darwincargo build --release --locked --target x86_64-apple-darwin- or the matching Linux or Windows target in CI
Generate platform package
From npm/:
- run
node ./scripts/render-platform-package.cjs <pkg> <version> <os> <arch> - create
<pkg>/bin - copy the built
smbbinary intobin/ - on Windows, use
smb.exe
Example:
node ./scripts/render-platform-package.cjs cli-darwin-arm64 0.3.33 darwin arm64
Publish order
- Publish each platform package with
npm publish --access public - Generate
npm/smbcloud-cli/package.jsonwithrender-main-package.cjs - Run
npm install - Run
npm run build - Publish
@smbcloud/cli
Local PyPI release workflow
Tooling
Use uv for local maturin installation in this repo.
Install:
uv tool install maturin
Upgrade later if needed:
uv tool upgrade maturin
If the shell cannot find maturin, use:
uv tool run maturin --version
Preflight
- Confirm the crate version in
crates/cli/Cargo.toml. - Make sure
.envexists withCLI_CLIENT_SECRET=...because the Rust build reads it at compile time. - If publishing from a local machine, use a PyPI API token. Trusted publishing is for CI.
Build and upload
From pypi/:
maturin build --release --locked --compatibility pypi --out distmaturin upload dist/*
Or publish in one step:
maturin publish --release --locked --compatibility pypi
For local uploads, export MATURIN_PYPI_TOKEN before running maturin upload or maturin publish.
Publishing the smb stub (one-time)
The stub lives in pypi/smb-stub/ and is built with hatchling, not maturin. It only needs to be published once — it never changes.
cd pypi/smb-stub
pip install hatchling build twine
python -m build
twine upload dist/*
Or with uv:
cd pypi/smb-stub
uv run --with build python -m build
uv run --with twine twine upload dist/*
Use a PyPI API token with upload scope for smb. Trusted publishing is not required for a static stub.
Do not republish the stub on every CLI release. It permanently depends on the unpinned smbcloud-cli, so uv always resolves the latest version when the tool environment is created or upgraded.
Local publishing constraint
A local publish normally builds only for the current platform.
Do not claim a full PyPI release is complete from one machine unless you intentionally published only one platform or separately produced all required wheels.
npm 2FA
Publishing may fail with EOTP.
When that happens, retry the exact npm publish command with:
--otp=<code>
Do not assume the first publish failed before the package upload step. Check the exit result or npm registry state before retrying repeatedly.
Trusted publishing
npm
Prefer npm trusted publishers for CI over NPM_TOKEN.
Official references:
npm-side constraints
Trusted publishing can only be configured for packages that already exist on npm.
That means:
- publish a package once manually if it does not exist yet
- then configure trust for that package
- each package can have only one trusted publisher configuration at a time
For smbcloud-cli, configure trust per package, not only for @smbcloud/cli.
Example packages:
@smbcloud/cli@smbcloud/cli-darwin-arm64- later, each additional published
@smbcloud/cli-*package
GitHub Actions setup
The workflow must include:
permissions:id-token: writecontents: read
Do not pass NODE_AUTH_TOKEN to npm publish when using trusted publishing.
The npm CLI detects the GitHub OIDC environment automatically and exchanges it for a short-lived publish credential.
Trusted publisher command
For this repo, the trust relationship should point at:
- repository:
smbcloudXYZ/smbcloud-cli - workflow file:
release-npm.yml
Example:
npm trust github @smbcloud/cli --repo smbcloudXYZ/smbcloud-cli --file release-npm.yml --yesnpm trust github @smbcloud/cli-darwin-arm64 --repo smbcloudXYZ/smbcloud-cli --file release-npm.yml --yes
These commands may require npm 2FA and support --otp=<code>.
Migration guidance
Recommended order:
- enable trusted publishing for existing packages
- verify a CI publish works through OIDC
- then remove or stop using
NPM_TOKEN - after the migration is proven, tighten npm package publishing access if desired
Do not remove the manual publish path for brand-new package names, because npm trust cannot be configured before the first publish.
PyPI
Use trusted publishing in GitHub Actions through pypa/gh-action-pypi-publish@release/v1.
Do not use trusted publishing as the default local-machine publish path.
CI/CD workflow rules
Shared rules
For both release workflows:
runs-onmust usematrix.build.OSwhen the matrix uses upper-case keys- derive
RELEASE_VERSIONfrom the git tag whenGITHUB_REF_TYPE=tag - for
workflow_dispatch, fall back to the version incrates/cli/Cargo.toml - read the Rust toolchain from
rust-toolchain.toml - pass that exact toolchain into
dtolnay/rust-toolchain - run
rustup target add <target> --toolchain ${{ env.RUST_TOOLCHAIN }}before cross-target builds
npm workflow
The npm workflow lives in .github/workflows/release-npm.yml.
Important rules:
- avoid
envsubstfor package generation across runners - use the Node generator scripts instead
- use
npm installandnpm run buildfor the wrapper package job
PyPI workflow
The PyPI workflow lives in .github/workflows/release-pypi.yml.
Important rules:
- build wheels with
PyO3/maturin-action@v1 - use
working-directory: pypi - pass
target: ${{ matrix.build.TARGET }} - use
manylinux: ${{ matrix.build.MANYLINUX || 'off' }} - build the sdist in a separate job
- publish only after wheel and sdist artifacts are downloaded into one directory
Rust toolchain consistency
When cross-compiling in CI, the Rust toolchain used for rustup target add must match the toolchain used by cargo build or maturin.
For this repo, rust-toolchain.toml is the only Rust version source of truth.
If the workflow installs a target for one toolchain but builds with another, CI can fail with:
error[E0463]: can't find crate for core
macOS cross-build constraint
On an Apple Silicon host, x86_64-apple-darwin may fail due to openssl-sys if only arm64 Homebrew OpenSSL exists under /opt/homebrew.
If that happens:
- do not claim the x64 package is releasable from that machine
- either build on an Intel Mac
- or use a Rosetta or x86 Homebrew toolchain with Intel OpenSSL under
/usr/local/opt/openssl@3 - or publish only the arm64 platform package and explicitly avoid calling the release complete
Do not publish @smbcloud/cli for a version unless you accept that missing platform packages for that version can break installs on those platforms.