[cicd] improved brief for vcs.change.state

open-telemetry · Sep 6, 2024 · 347b15b · 347b15b
1 parent a148a4e
commit 347b15b
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/docs/attributes-registry/vcs.md b/docs/attributes-registry/vcs.md
@@ -12,7 +12,7 @@ This group defines the attributes for [Version Control Systems (VCS)](https://en
 
 | Attribute                     | Type   | Description                                                                                                                                                                                | Examples                                                                                                                             | Stability                                                        |
 | ----------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------- |
-| `vcs.change.state`            | string | The state of a change (pull request).                                                                                                                                                      | `open`; `closed`; `merged`                                                                                                           | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `vcs.change.state`            | string | The state of the change (pull request/merge request).                                                                                                                                      | `open`; `closed`; `merged`                                                                                                           | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `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`                                                                                                                                | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `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`                                                        | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `vcs.repository.name`         | string | The name of the repository.                                                                                                                                                                | `open-telemetry-collector-contrib`; `opentelemetry/open-telemetry-collector-contrib`; `my-org/my-project/my-projects-project`        | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

diff --git a/docs/cicd/cicd-metrics.md b/docs/cicd/cicd-metrics.md
@@ -61,7 +61,7 @@ but more may be added in the future.
 
 | Attribute  | Type | Description  | Examples  | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
 |---|---|---|---|---|---|
-| [`vcs.change.state`](/docs/attributes-registry/vcs.md) | string | The state of a change (pull request). | `open`; `closed`; `merged` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| [`vcs.change.state`](/docs/attributes-registry/vcs.md) | string | The state of the change (pull request/merge request). | `open`; `closed`; `merged` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | [`vcs.repository.name`](/docs/attributes-registry/vcs.md) | string | The name of the repository. | `open-telemetry-collector-contrib`; `opentelemetry/open-telemetry-collector-contrib`; `my-org/my-project/my-projects-project` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 `vcs.change.state` 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.

diff --git a/model/registry/vcs.yaml b/model/registry/vcs.yaml
@@ -111,5 +111,5 @@ groups:
               stability: experimental
         stability: experimental
         brief: >
-          The state of a change (pull request).
+          The state of the change (pull request/merge request).
         examples: ["open", "closed", "merged"]