gritpack publication

Publish several packages step by step: plan, verify, publish

Generated from gritpack publication --helpGritpack 1.2.63
gritpack publication [OPTIONS] <COMMAND>

Commands

plan
Build the package files and write a publication plan, without publishing
verify
Check a plan's package files, then check the plan with the hub
publish
Publish every package in a verified plan, all or none
status
Show a publication in progress, or its receipt once it is done
resume
Finish an interrupted publication that is ready to commit
abort
Cancel a publication that has not begun committing, freeing its versions

Options

-h, --helpPrint help

gritpack publication plan

Build the package files and write a publication plan, without publishing

gritpack publication plan [OPTIONS] --repository <REPOSITORY>

Options

--path <PATH>Workspace directory, workspace manifest, or single package directoryDefault: .
--repository <REPOSITORY>UUID of the hub repository the plan publishes to
--hub <HUB>The hub's package address recorded in the plan
--cargo-registry <CARGO_REGISTRY>Cargo registry name used in Cargo package metadata; default the repository UUID
--package <CARGO_PACKAGES>Only these Cargo packages, by name; repeat as needed
--member <MEMBERS>Only these workspace members, by package name or path; repeat as needed
--cargo <CARGO>Cargo program used to package Cargo membersDefault: cargo
--rustc <RUSTC>Rust compiler whose version is recorded for Cargo membersDefault: rustc
--npm <NPM>npm program used to package npm membersDefault: npm
--allow-dirtyLet Cargo package uncommitted changes
--version <VERSION>Go: version of a module given as go.mod, with its leading v
--published-at <GO_PUBLISHED_AT>Go: publication time recorded for that version, in RFC 3339 form
--without-readme <REASON>Publish new versions without a README of 100 words; your reason, in words of your own, is shown with each version that needs it
--without-license <REASON>Publish new versions without a license declaration; your reason, in words of your own, is shown with each version that needs it
--artifacts-dir <ARTIFACTS_DIR>Where built package files go, relative to the workspace rootDefault: .gritpack/publication/artifacts
--plan <PLAN>Where to write the plan, relative to the workspace rootDefault: .gritpack/publication-plan.json
--format <FORMAT>Output format: human, json or ndjsonDefault: human · Values: human, json, ndjson
--json[=<FIELDS>]Same as --format json; --json=name,version keeps only those fields
--jq <EXPRESSION>Print the JSON output through a jq expression, strings unquoted
-h, --helpPrint help

gritpack publication verify

Check a plan's package files, then check the plan with the hub

gritpack publication verify [OPTIONS] <PLAN>

Arguments

<PLAN>Plan file written by gritpack publication plan

Options

--path <WORKSPACE>Workspace root that the plan's file paths are relative toDefault: .
--format <FORMAT>Output format: human, json or ndjsonDefault: human · Values: human, json, ndjson
--json[=<FIELDS>]Same as --format json; --json=name,version keeps only those fields
--jq <EXPRESSION>Print the JSON output through a jq expression, strings unquoted
-h, --helpPrint help (see a summary with '-h')

Hub connection

--hub <HUB>The hub, as host[:port] or https://host[:port]Environment: GRITPACK_SERVER
--cert <CERT>Client certificate for the hubEnvironment: GRITPACK_CERT
--key <KEY>Private key for the client certificateEnvironment: GRITPACK_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA
--profile <PROFILE>Login profile to use; cannot be combined with --hub, --cert, --key or --caEnvironment: GRITPACK_PROFILE
--config <CONFIG>Profile configuration fileEnvironment: GRITPACK_CONFIG · Default: ~/.frogfish/gritpack/config.toml
--credentials-dir <CREDENTIALS_DIR>With --hub alone: directory searched for your login; exactly one may be unexpiredEnvironment: GRITPACK_CREDENTIALS_DIR · Default: ~/.frogfish/gritpack/credentials
--cache-dir <CACHE_DIR>Directory of the shared cache of downloaded package filesEnvironment: GRITPACK_CACHE_DIR · Default: ~/.frogfish/gritpack/cache
--jobs <JOBS>How many package downloads to run at once (1-64)Environment: GRITPACK_JOBS · Default: 4

gritpack publication publish

Publish every package in a verified plan, all or none

gritpack publication publish [OPTIONS] <PLAN>

Arguments

<PLAN>Plan file written by gritpack publication plan

Options

--path <WORKSPACE>Workspace root that the plan's file paths are relative toDefault: .
--attestation <ATTESTATIONS>A publisher signature as NODE_ID=FILE; repeat when several are required
--format <FORMAT>Output format: human, json or ndjsonDefault: human · Values: human, json, ndjson
--json[=<FIELDS>]Same as --format json; --json=name,version keeps only those fields
--jq <EXPRESSION>Print the JSON output through a jq expression, strings unquoted
-h, --helpPrint help (see a summary with '-h')

Hub connection

--hub <HUB>The hub, as host[:port] or https://host[:port]Environment: GRITPACK_SERVER
--cert <CERT>Client certificate for the hubEnvironment: GRITPACK_CERT
--key <KEY>Private key for the client certificateEnvironment: GRITPACK_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA
--profile <PROFILE>Login profile to use; cannot be combined with --hub, --cert, --key or --caEnvironment: GRITPACK_PROFILE
--config <CONFIG>Profile configuration fileEnvironment: GRITPACK_CONFIG · Default: ~/.frogfish/gritpack/config.toml
--credentials-dir <CREDENTIALS_DIR>With --hub alone: directory searched for your login; exactly one may be unexpiredEnvironment: GRITPACK_CREDENTIALS_DIR · Default: ~/.frogfish/gritpack/credentials
--cache-dir <CACHE_DIR>Directory of the shared cache of downloaded package filesEnvironment: GRITPACK_CACHE_DIR · Default: ~/.frogfish/gritpack/cache
--jobs <JOBS>How many package downloads to run at once (1-64)Environment: GRITPACK_JOBS · Default: 4

gritpack publication status

Show a publication in progress, or its receipt once it is done

gritpack publication status [OPTIONS] <TRANSACTION_ID>

Arguments

<TRANSACTION_ID>Publication transaction ID, as printed by publish

Options

--format <FORMAT>Output format: human, json or ndjsonDefault: human · Values: human, json, ndjson
--json[=<FIELDS>]Same as --format json; --json=name,version keeps only those fields
--jq <EXPRESSION>Print the JSON output through a jq expression, strings unquoted
-h, --helpPrint help (see a summary with '-h')

Hub connection

--hub <HUB>The hub, as host[:port] or https://host[:port]Environment: GRITPACK_SERVER
--cert <CERT>Client certificate for the hubEnvironment: GRITPACK_CERT
--key <KEY>Private key for the client certificateEnvironment: GRITPACK_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA
--profile <PROFILE>Login profile to use; cannot be combined with --hub, --cert, --key or --caEnvironment: GRITPACK_PROFILE
--config <CONFIG>Profile configuration fileEnvironment: GRITPACK_CONFIG · Default: ~/.frogfish/gritpack/config.toml
--credentials-dir <CREDENTIALS_DIR>With --hub alone: directory searched for your login; exactly one may be unexpiredEnvironment: GRITPACK_CREDENTIALS_DIR · Default: ~/.frogfish/gritpack/credentials
--cache-dir <CACHE_DIR>Directory of the shared cache of downloaded package filesEnvironment: GRITPACK_CACHE_DIR · Default: ~/.frogfish/gritpack/cache
--jobs <JOBS>How many package downloads to run at once (1-64)Environment: GRITPACK_JOBS · Default: 4

gritpack publication resume

Finish an interrupted publication that is ready to commit

gritpack publication resume [OPTIONS] <TRANSACTION_ID>

Arguments

<TRANSACTION_ID>Publication transaction ID, as printed by publish

Options

--format <FORMAT>Output format: human, json or ndjsonDefault: human · Values: human, json, ndjson
--json[=<FIELDS>]Same as --format json; --json=name,version keeps only those fields
--jq <EXPRESSION>Print the JSON output through a jq expression, strings unquoted
-h, --helpPrint help (see a summary with '-h')

Hub connection

--hub <HUB>The hub, as host[:port] or https://host[:port]Environment: GRITPACK_SERVER
--cert <CERT>Client certificate for the hubEnvironment: GRITPACK_CERT
--key <KEY>Private key for the client certificateEnvironment: GRITPACK_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA
--profile <PROFILE>Login profile to use; cannot be combined with --hub, --cert, --key or --caEnvironment: GRITPACK_PROFILE
--config <CONFIG>Profile configuration fileEnvironment: GRITPACK_CONFIG · Default: ~/.frogfish/gritpack/config.toml
--credentials-dir <CREDENTIALS_DIR>With --hub alone: directory searched for your login; exactly one may be unexpiredEnvironment: GRITPACK_CREDENTIALS_DIR · Default: ~/.frogfish/gritpack/credentials
--cache-dir <CACHE_DIR>Directory of the shared cache of downloaded package filesEnvironment: GRITPACK_CACHE_DIR · Default: ~/.frogfish/gritpack/cache
--jobs <JOBS>How many package downloads to run at once (1-64)Environment: GRITPACK_JOBS · Default: 4

gritpack publication abort

Cancel a publication that has not begun committing, freeing its versions

gritpack publication abort [OPTIONS] <TRANSACTION_ID>

Arguments

<TRANSACTION_ID>Publication transaction ID, as printed by publish

Options

--format <FORMAT>Output format: human, json or ndjsonDefault: human · Values: human, json, ndjson
--json[=<FIELDS>]Same as --format json; --json=name,version keeps only those fields
--jq <EXPRESSION>Print the JSON output through a jq expression, strings unquoted
-h, --helpPrint help (see a summary with '-h')

Hub connection

--hub <HUB>The hub, as host[:port] or https://host[:port]Environment: GRITPACK_SERVER
--cert <CERT>Client certificate for the hubEnvironment: GRITPACK_CERT
--key <KEY>Private key for the client certificateEnvironment: GRITPACK_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA
--profile <PROFILE>Login profile to use; cannot be combined with --hub, --cert, --key or --caEnvironment: GRITPACK_PROFILE
--config <CONFIG>Profile configuration fileEnvironment: GRITPACK_CONFIG · Default: ~/.frogfish/gritpack/config.toml
--credentials-dir <CREDENTIALS_DIR>With --hub alone: directory searched for your login; exactly one may be unexpiredEnvironment: GRITPACK_CREDENTIALS_DIR · Default: ~/.frogfish/gritpack/credentials
--cache-dir <CACHE_DIR>Directory of the shared cache of downloaded package filesEnvironment: GRITPACK_CACHE_DIR · Default: ~/.frogfish/gritpack/cache
--jobs <JOBS>How many package downloads to run at once (1-64)Environment: GRITPACK_JOBS · Default: 4