buildnote submit deployment

Submits a deployment

Usage

buildnote submit deployment <options>

Options

--tag

Adds a tag to every collected event.

Example:

--tag "Unit Tests"

To add several tags, repeat the option.

Example with several tags:

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

Values: value

---

--environment

Environment you deployed to, such as production or staging-eu

Values: text

---

--production

Marks the deployment as a production deployment

---

--status

Status of the deployment

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

---

--category

Type of deployment: release for a planned release, rollback for a revert, or hotfix for an unplanned fix

Values: (release|rollback|hotfix)

---

--started-at

When the deployment started, as an ISO-8601 timestamp such as 2026-07-04T12:34:08Z. Defaults to now.

Values: value

---

--completed-at

When the deployment completed, as an ISO-8601 timestamp such as 2026-07-04T12:34:08Z. Defaults to now, unless the status is running.

Values: value

---

--version

Human-readable version or tag of what you deployed

Values: text

---

--url

Link to the deployment, such as a GitHub deployment page or a run in your CD tool

Values: value

---

-h, --help

Show this message and exit

---