Skip to content

Commit e531541

Browse files
jsueretharminru
jsuereth
and
arminru
authored
Update documentation for how to cut a release AND perform the action … (#190)
Co-authored-by: Armin Ruech <[email protected]>
1 parent ca88107 commit e531541

File tree

5 files changed

+165
-12
lines changed

5 files changed

+165
-12
lines changed

‎CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ release.
77

88
## Unreleased
99

10+
## v1.21.0 (2023-07-13)
11+
1012
Note: This is the first release of Semantic Conventions separate from the Specification.
1113

1214
- Add GCP Bare Metal Solution as a cloud platform

‎CONTRIBUTING.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,3 +122,18 @@ make misspell-correction
122122
3. Modify `LATEST_SPECIFICATION_VERSION` to the latest specification tag, e.g. `1.21`
123123
4. Run the script from the root directory, e.g. `semantic-conventions$ ./internal/tools/update_specification_version.sh`.
124124
5. Add all modified files to the change submit and submit a PR.
125+
126+
## Making a Release
127+
128+
- Ensure the referenced specification version is up to date. Use
129+
[tooling to update the spec](#updating-the-referenced-specification-version)
130+
if needed.
131+
- Create a staging branch for the release.
132+
- Update `schema-next.yaml` file and move to `schemas/{version}`
133+
- Ensure the `next` version is appropriately configured as the `{version}`.
134+
- Copy `schema-next.yaml` to `schemas/{version}`.
135+
- Add `next` as a version in `schema-next.yaml` version.
136+
- Update `CHANGELOG.md` for the latest version.
137+
- Add `## v{version} ({date})` under `## Unreleased`
138+
- Send staging tag as PR for review.
139+
- Create a tag `v{version}` on the merged PR and push remote.

‎README.md‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,6 @@ This repository is currently using [this specification version][SpecificationVer
1111

1212
The documentation currently resides in the [doc](docs/README.md) folder.
1313

14-
## TODOs
15-
16-
- [ ] Set up SchemaURL publication
17-
- [ ] Contributing.MD document
18-
- [ ] Restructure markdown for easier consumption.
19-
2014
## Contributing
2115

2216
See [CONTRIBUTING.md](CONTRIBUTING.md)

‎internal/tools/schema_check.sh‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,15 @@ grep -o -e '## v[1-9].*\s' $root_dir/CHANGELOG.md | grep -o '[1-9].*' | while re
3232
exit 3
3333
fi
3434

35-
curl --no-progress-meter https://opentelemetry.io/schemas/$ver > verify$ver
36-
37-
diff verify$ver $file && echo "Published schema at https://opentelemetry.io/schemas/$ver is correct" \
38-
|| (echo "Published schema at https://opentelemetry.io/schemas/$ver is incorrect!" && exit 3)
39-
40-
rm verify$ver
35+
# Schema file will no be served directly from this repository when linked
36+
# into opentelemetry.io. We disable this for now and need to move the check
37+
# into the website.
38+
# curl --no-progress-meter https://opentelemetry.io/schemas/$ver > verify$ver
39+
#
40+
# diff verify$ver $file && echo "Published schema at https://opentelemetry.io/schemas/$ver is correct" \
41+
# || (echo "Published schema at https://opentelemetry.io/schemas/$ver is incorrect!" && exit 3)
42+
#
43+
# rm verify$ver
4144
done
4245

4346
# Now check the content of all schema files in the ../shemas directory.

‎schema-next.yaml‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
file_format: 1.1.0
2+
schema_url: https://opentelemetry.io/schemas/1.21.0
3+
versions:
4+
next:
5+
1.21.0:
6+
spans:
7+
changes:
8+
# https://github.com/open-telemetry/opentelemetry-specification/pull/3336
9+
- rename_attributes:
10+
attribute_map:
11+
messaging.kafka.client_id: messaging.client_id
12+
messaging.rocketmq.client_id: messaging.client_id
13+
# https://github.com/open-telemetry/opentelemetry-specification/pull/3402
14+
- rename_attributes:
15+
attribute_map:
16+
# net.peer.(name|port) attributes were usually populated on client side
17+
# so they should be usually translated to server.(address|port)
18+
# net.host.* attributes were only populated on server side
19+
net.host.name: server.address
20+
net.host.port: server.port
21+
# was only populated on client side
22+
net.sock.peer.name: server.socket.domain
23+
# net.sock.peer.(addr|port) mapping is not possible
24+
# since they applied to both client and server side
25+
# were only populated on server side
26+
net.sock.host.addr: server.socket.address
27+
net.sock.host.port: server.socket.port
28+
http.client_ip: client.address
29+
# https://github.com/open-telemetry/opentelemetry-specification/pull/3426
30+
- rename_attributes:
31+
attribute_map:
32+
net.protocol.name: network.protocol.name
33+
net.protocol.version: network.protocol.version
34+
net.host.connection.type: network.connection.type
35+
net.host.connection.subtype: network.connection.subtype
36+
net.host.carrier.name: network.carrier.name
37+
net.host.carrier.mcc: network.carrier.mcc
38+
net.host.carrier.mnc: network.carrier.mnc
39+
net.host.carrier.icc: network.carrier.icc
40+
# https://github.com/open-telemetry/opentelemetry-specification/pull/3355
41+
- rename_attributes:
42+
attribute_map:
43+
http.method: http.request.method
44+
http.status_code: http.response.status_code
45+
http.scheme: url.scheme
46+
http.url: url.full
47+
http.request_content_length: http.request.body.size
48+
http.response_content_length: http.response.body.size
49+
metrics:
50+
changes:
51+
# https://github.com/open-telemetry/semantic-conventions/pull/53
52+
- rename_metrics:
53+
process.runtime.jvm.cpu.utilization: process.runtime.jvm.cpu.recent_utilization
54+
1.20.0:
55+
spans:
56+
changes:
57+
# https://github.com/open-telemetry/opentelemetry-specification/pull/3272
58+
- rename_attributes:
59+
attribute_map:
60+
net.app.protocol.name: net.protocol.name
61+
net.app.protocol.version: net.protocol.version
62+
1.19.0:
63+
spans:
64+
changes:
65+
# https://github.com/open-telemetry/opentelemetry-specification/pull/3209
66+
- rename_attributes:
67+
attribute_map:
68+
faas.execution: faas.invocation_id
69+
# https://github.com/open-telemetry/opentelemetry-specification/pull/3188
70+
- rename_attributes:
71+
attribute_map:
72+
faas.id: cloud.resource_id
73+
# https://github.com/open-telemetry/opentelemetry-specification/pull/3190
74+
- rename_attributes:
75+
attribute_map:
76+
http.user_agent: user_agent.original
77+
resources:
78+
changes:
79+
# https://github.com/open-telemetry/opentelemetry-specification/pull/3190
80+
- rename_attributes:
81+
attribute_map:
82+
browser.user_agent: user_agent.original
83+
1.18.0:
84+
1.17.0:
85+
spans:
86+
changes:
87+
# https://github.com/open-telemetry/opentelemetry-specification/pull/2957
88+
- rename_attributes:
89+
attribute_map:
90+
messaging.consumer_id: messaging.consumer.id
91+
messaging.protocol: net.app.protocol.name
92+
messaging.protocol_version: net.app.protocol.version
93+
messaging.destination: messaging.destination.name
94+
messaging.temp_destination: messaging.destination.temporary
95+
messaging.destination_kind: messaging.destination.kind
96+
messaging.message_id: messaging.message.id
97+
messaging.conversation_id: messaging.message.conversation_id
98+
messaging.message_payload_size_bytes: messaging.message.payload_size_bytes
99+
messaging.message_payload_compressed_size_bytes: messaging.message.payload_compressed_size_bytes
100+
messaging.rabbitmq.routing_key: messaging.rabbitmq.destination.routing_key
101+
messaging.kafka.message_key: messaging.kafka.message.key
102+
messaging.kafka.partition: messaging.kafka.destination.partition
103+
messaging.kafka.tombstone: messaging.kafka.message.tombstone
104+
messaging.rocketmq.message_type: messaging.rocketmq.message.type
105+
messaging.rocketmq.message_tag: messaging.rocketmq.message.tag
106+
messaging.rocketmq.message_keys: messaging.rocketmq.message.keys
107+
messaging.kafka.consumer_group: messaging.kafka.consumer.group
108+
1.16.0:
109+
1.15.0:
110+
spans:
111+
changes:
112+
# https://github.com/open-telemetry/opentelemetry-specification/pull/2743
113+
- rename_attributes:
114+
attribute_map:
115+
http.retry_count: http.resend_count
116+
1.14.0:
117+
1.13.0:
118+
spans:
119+
changes:
120+
# https://github.com/open-telemetry/opentelemetry-specification/pull/2614
121+
- rename_attributes:
122+
attribute_map:
123+
net.peer.ip: net.sock.peer.addr
124+
net.host.ip: net.sock.host.addr
125+
1.12.0:
126+
1.11.0:
127+
1.10.0:
128+
1.9.0:
129+
1.8.0:
130+
spans:
131+
changes:
132+
- rename_attributes:
133+
attribute_map:
134+
db.cassandra.keyspace: db.name
135+
db.hbase.namespace: db.name
136+
1.7.0:
137+
1.6.1:
138+
1.5.0:
139+
1.4.0:

0 commit comments

Comments
 (0)