diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7efad36fa2..2ab5ce406e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,6 +30,8 @@ key, but non-obvious, aspects: defined in a schema file. As part of any contribution, you should include attribute changes defined in the `schema-next.yaml` file. For details, please read [the schema specification](https://opentelemetry.io/docs/specs/otel/schemas/). +- Links to the specification repository MUST point to a tag and **not** to the `main` branch. + The tag version MUST match with the one defined in [README](README.md). - After creating a pull request, please update the [CHANGELOG](CHANGELOG.md) file with a description of your changes. diff --git a/README.md b/README.md index dd38f511dc..4584d9d648 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,16 @@ -# OpenTelemetry Semantic Conventions +# OpenTelemetry Icon OpenTelemetry Semantic Conventions -Welcome to the new repository! +[![Checks](https://github.com/open-telemetry/semantic-conventions/workflows/Checks/badge.svg?branch=main)](https://github.com/open-telemetry/semantic-conventions/actions?query=workflow%3A%22Checks%22+branch%3Amain) +[![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/open-telemetry/semantic-conventions.svg?logo=opentelemetry&&color=f5a800&label=Latest%20release)](https://github.com/open-telemetry/semantic-conventions/releases/latest) +[![Specification Version](https://img.shields.io/badge/OTel_specification_version-v1.26.0-blue?logo=opentelemetry&color=f5a800)](https://github.com/open-telemetry/opentelemetry-specification/releases/tag/v1.26.0) -This is currently a direct copy/filter-branch of the Specification repository -with only semantic conventions included. - -This repository is currently using [this specification version][SpecificationVersion]. +Semantic Conventions define a common set of (semantic) attributes which +provide meaning to data when collecting, producing and consuming it. ## Read the docs -The documentation currently resides in the [docs](docs/README.md) folder. +The human-readable version of the semantic conventions resides in the [docs](docs/README.md) folder. +Major parts of these Markdown documents are generated from the YAML definitions located in the [model](model/README.md) folder. ## Contributing @@ -34,6 +35,4 @@ Maintainers ([@open-telemetry/specs-semconv-maintainers](https://github.com/orgs - [Josh Suereth](https://github.com/jsuereth), Google - [Reiley Yang](https://github.com/reyang), Microsoft -_Find more about the maintainer role in [community repository](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer)._ - -[SpecificationVersion]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0 +_Find more about the maintainer role in [community repository](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer). diff --git a/internal/tools/update_specification_version.sh b/internal/tools/update_specification_version.sh index 86cd140b88..765c6c6f88 100755 --- a/internal/tools/update_specification_version.sh +++ b/internal/tools/update_specification_version.sh @@ -12,6 +12,9 @@ LATEST_SPECIFICATION_VERSION="v1.26.0" # The specific pattern we look for when replacing URLs SPECIFICATION_URL_PREFIX="https://github.com/open-telemetry/opentelemetry-specification/tree/" SPECIFICATION_BLOB_URL_PREFIX="https://github.com/open-telemetry/opentelemetry-specification/blob/" +# The specific pattern we look for updating the Badge with the spec version +SPECIFICATION_BADGE_PREFIX="https://img.shields.io/badge/OTel_specification_version-" +SPECIFICATION_BADGE_RELEASE_TAG_PREFIX="https://github.com/open-telemetry/opentelemetry-specification/releases/tag/" fix_file() { @@ -19,6 +22,8 @@ fix_file() { sed -i \ -e "s,${SPECIFICATION_URL_PREFIX}${PREVIOUS_SPECIFICATION_VERSION},${SPECIFICATION_URL_PREFIX}${LATEST_SPECIFICATION_VERSION},g" \ -e "s,${SPECIFICATION_BLOB_URL_PREFIX}${PREVIOUS_SPECIFICATION_VERSION},${SPECIFICATION_URL_PREFIX}${LATEST_SPECIFICATION_VERSION},g" \ + -e "s,${SPECIFICATION_BADGE_PREFIX}${PREVIOUS_SPECIFICATION_VERSION},${SPECIFICATION_BADGE_PREFIX}${LATEST_SPECIFICATION_VERSION},g" \ + -e "s,${SPECIFICATION_BADGE_RELEASE_TAG_PREFIX}${PREVIOUS_SPECIFICATION_VERSION},${SPECIFICATION_BADGE_RELEASE_TAG_PREFIX}${LATEST_SPECIFICATION_VERSION},g" \ "$1" }