VCS
VCS Repository Attributes
This group defines the attributes for Version Control Systems (VCS).
Attribute | Type | Description | Examples | Stability |
---|---|---|---|---|
vcs.repository.change.id | string | The ID of the change (pull request/merge request) if applicable. This is usually a unique (within repository) identifier generated by the VCS system. | 123 | |
vcs.repository.change.title | string | The human readable title of the change (pull request/merge request). This title is often a brief summary of the change and may get merged in to a ref as the commit summary. | Fixes broken thing ; feat: add my new feature ; [chore] update dependency | |
vcs.repository.ref.name | string | The name of the reference such as branch or tag in the repository. | my-feature-branch ; tag-1-test | |
vcs.repository.ref.revision | string | The revision, literally revised version, The revision most often refers to a commit object in Git, or a revision number in SVN. [1] | 9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc ; main ; 123 ; HEAD | |
vcs.repository.ref.type | string | The type of the reference in the repository. | branch ; tag | |
vcs.repository.url.full | string | The URL of the repository providing the complete address in order to locate and identify the repository. | https://github.com/opentelemetry/open-telemetry-collector-contrib ; https://gitlab.com/my-org/my-project/my-projects-project/repo |
[1]: 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.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.
vcs.repository.ref.type
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 |
---|---|---|
branch | branch | |
tag | tag |
Feedback
Was this page helpful?
Thank you. Your feedback is appreciated!
Please let us know how we can improve this page. Your feedback is appreciated!