Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve visibility of used spec version in the semconv repo #558

Merged
merged 10 commits into from
Nov 24, 2023
Merged

Improve visibility of used spec version in the semconv repo #558

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
091cdc8
Use badge for specification version
joaopgrassi Nov 23, 2023
634823f
Update spec badge via script
joaopgrassi Nov 23, 2023
3172eb4
Make clear links to the spec repo must use a tag
joaopgrassi Nov 23, 2023
f424fcf
Fix link
joaopgrassi Nov 23, 2023
78ed508
Improve text
joaopgrassi Nov 23, 2023
7ad20cf
Apply suggestions from code review
joaopgrassi Nov 23, 2023
1def82b
PR suggestions
joaopgrassi Nov 23, 2023
5c460b4
Fix link to model
joaopgrassi Nov 23, 2023
347df12
PR suggestions
joaopgrassi Nov 24, 2023
5d537b0
Merge branch 'main' into improve-spec-version-used
joaopgrassi Nov 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
18 changes: 10 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
# OpenTelemetry Semantic Conventions

Welcome to the new repository!
[![Checks](https:/open-telemetry/semantic-conventions/workflows/Checks/badge.svg?branch=main)](https:/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:/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:/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.
![OpenTelemetry Logo](https://opentelemetry.io/img/logos/opentelemetry-horizontal-color.png)
joaopgrassi marked this conversation as resolved.
Show resolved Hide resolved

This repository is currently using [this specification version][SpecificationVersion].
Semantic Conventions define a contract between the signals that
instrumentation will provide and analysis tools that consume
the instrumentation (e.g. dashboards, alerts, queries, etc.).
joaopgrassi marked this conversation as resolved.
Show resolved Hide resolved

## 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.
joaopgrassi marked this conversation as resolved.
Show resolved Hide resolved
Major parts of these Markdown documents are generated from the YAML definitions located in the [model](model/README.md) folder.

## Contributing

Expand All @@ -34,6 +38,4 @@ Maintainers ([@open-telemetry/specs-semconv-maintainers](https:/orgs
- [Josh Suereth](https:/jsuereth), Google
- [Reiley Yang](https:/reyang), Microsoft

_Find more about the maintainer role in [community repository](https:/open-telemetry/community/blob/master/community-membership.md#maintainer)._

[SpecificationVersion]: https:/open-telemetry/opentelemetry-specification/tree/v1.26.0
_Find more about the maintainer role in [community repository](https:/open-telemetry/community/blob/master/community-membership.md#maintainer).
5 changes: 5 additions & 0 deletions internal/tools/update_specification_version.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,18 @@ LATEST_SPECIFICATION_VERSION="v1.26.0"
# The specific pattern we look for when replacing URLs
SPECIFICATION_URL_PREFIX="https:/open-telemetry/opentelemetry-specification/tree/"
SPECIFICATION_BLOB_URL_PREFIX="https:/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:/open-telemetry/opentelemetry-specification/releases/tag/"

joaopgrassi marked this conversation as resolved.
Show resolved Hide resolved

fix_file() {
echo Fixing file $1
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"
}

Expand Down
Loading