Debian Codegraph @

internal/tools/semconvkit/templates/MIGRATION.md.tmpl

raw
1 <!-- Generated. DO NOT MODIFY. -->
2 {{ if .PrevVer -}}
3 # Migration from {{ .PrevVer }} to {{ .CurVer }}
4 {{ if or .Removals .Renames }}
5 The `go.opentelemetry.io/otel/semconv/{{ .CurVer }}` package should be a drop-in replacement for `go.opentelemetry.io/otel/semconv/{{ .PrevVer }}` with the following exceptions.
6 {{ if .Renames }}
7 ## Renames
8
9 The following renames have been introduced to better match Go and industry naming standards.
10 Be sure to update any use from `go.opentelemetry.io/otel/semconv/{{ .PrevVer }}` with the equivalent in `go.opentelemetry.io/otel/semconv/{{ .CurVer }}`.
11
12 | `{{ .PrevVer }}` | `{{ .CurVer }}` |
13 | --- | --- |
14 {{ range .Renames -}}
15 | `{{ .Old }}` | `{{ .New }}` |
16 {{ end -}}
17 {{ end -}}
18 {{ if .Removals }}
19 ## Removed
20
21 The following declarations have been removed.
22 Refer to the [OpenTelemetry Semantic Conventions documentation] for deprecation instructions.
23
24 If the type is not listed in the documentation as deprecated, it has been removed in this version due to lack of applicability or use.
25 If you use any of these non-deprecated declarations in your Go application, please [open an issue] describing your use-case.
26
27 {{ range .Removals -}}
28 - `{{ . }}`
29 {{ end }}
30 [OpenTelemetry Semantic Conventions documentation]: https://github.com/open-telemetry/semantic-conventions
31 [open an issue]: https://github.com/open-telemetry/opentelemetry-go/issues/new?template=Blank+issue
32 {{ end -}}
33 {{ else }}
34 The `go.opentelemetry.io/otel/semconv/{{ .CurVer }}` package should be a drop-in replacement for `go.opentelemetry.io/otel/semconv/{{ .PrevVer }}`.
35 {{ end -}}
36 {{ else }}
37 # {{ .CurVer }} Migration
38
39 The `go.opentelemetry.io/otel/semconv/{{ .CurVer }}` package should be a drop-in replacement for previous versions of the prior `go.opentelemetry.io/otel/semconv`.
40 {{ end -}}