buildnote

Appearance

buildnote submit deployment ​

Collects a deployment

Usage ​

buildnote submit deployment <options>

Options ​

--tag ​

All collected events will be tagged with specified tags.

Example:

shell
--tag "Unit Tests"

You can also specify multiple tags by repeating this option.

Example of multiple tags:

shell
--tag "Unit Tests" --tag "All Tests"

Values: value

--environment ​

Target environment (e.g. production, staging-eu)

Values: text

--production ​

Marks the deployment as targeting production

--status ​

Status of the deployment

Values: (running|successful|failed|skipped|cancelled|unknown)

--category ​

Type of deployment: release (planned), rollback (revert), hotfix (unplanned corrective)

Values: (release|rollback|hotfix)

--started-at ​

ISO-8601 timestamp the deployment started, e.g. 2026-07-04T12:34:08Z (defaults to now)

Values: value

--completed-at ​

ISO-8601 timestamp the deployment completed, e.g. 2026-07-04T12:34:08Z (defaults to now unless status is running)

Values: value

--version ​

Human-readable version or tag being deployed

Values: text

--url ​

Link to the deployment (e.g. GitHub deployment page, CD tool run)

Values: value

-h, --help ​

Show this message and exit