Status:

The event name MUST be dash0.deployment.

Marks the deployment of a service version to an environment.

A dash0.deployment event SHOULD be emitted once per deployment, after the deployment has completed (successfully or not). It is intended to be sent from CI/CD pipelines (e.g., a GitHub Action).

A deployment MUST be associated with a service resource and SHOULD be associated with a deployment resource. This can not be fully expressed in the schema, but Dash0 requires the following resource attributes to be set on the events resource:

service.name
service.namespace (if set on the target resource)

Additionally the following resource attributes SHOULD be set:

service.version
deployment.environment.name
deployment.name
deployment.id

The event SHOULD be associated with one of the following entities:

entity.internal.dash0.deployment

View dash0.deployment events in Dash0

Attributes:

Key	Requirement Level	Value Type	Description	Example Values
`deployment.status`	`Recommended`	string	The status of the deployment.	`failed`; `succeeded`
`vcs.ref.head.name`	`Opt-In`	string	The name of the reference such as branch or tag in the repository. [1]	`my-feature-branch`; `tag-1-test`
`vcs.ref.head.revision`	`Opt-In`	string	The revision, literally revised version, The revision most often refers to a commit object in Git, or a revision number in SVN. [2]	`9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc`; `main`; `123`; `HEAD`
`vcs.repository.url.full`	`Opt-In`	string	The canonical URL of the repository providing the complete HTTP(S) address in order to locate and identify the repository through a browser. [3]	`https://github.com/opentelemetry/open-telemetry-collector-contrib`; `https://gitlab.com/my-org/my-project/my-projects-project/repo`

[1] vcs.ref.head.name: head refers to where you are right now; the current reference at a given time.

[2] vcs.ref.head.revision: head refers to where you are right now; the current reference at a given time.The revision can be a full hash value (see glossary), of the recorded change to a ref within a repository pointing to a commit commit object. It does not necessarily have to be a hash; it can simply define a revision number which is an integer that is monotonically increasing. In cases where it is identical to the ref.head.name, it SHOULD still be included. It is up to the implementer to decide which value to set as the revision based on the VCS system and situational context.

[3] vcs.repository.url.full: In Git Version Control Systems, the canonical URL SHOULD NOT include the .git extension.

deployment.status has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
`failed`	failed
`succeeded`	succeeded

Deployment Events