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.

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

Add Versioning Policy to README #167

Merged
merged 3 commits into from
May 9, 2024

Conversation

florianl
Copy link
Contributor

With the OTel Profiling signal v1experimental was introduced. This might break backwards compatability if v1experimental gets replaced with v1. Add a section to the Readme to make users aware of this risk.

With the OTel Profiling signal v1experimental was introduced. This might break backwards compatability if v1experimental gets  replaced with v1.
Add a section to the Readme to make users aware of this risk.
@florianl florianl requested a review from a team April 30, 2024 07:34
Co-authored-by: Damien Mathieu <42@dmathieu.com>
@MrAlias
Copy link
Contributor

MrAlias commented May 6, 2024

cc @tigrannajaryan

@tigrannajaryan tigrannajaryan merged commit cfa3298 into open-telemetry:main May 9, 2024
3 checks passed
MrAlias referenced this pull request in open-telemetry/opentelemetry-go Jun 17, 2024
)

[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[go.opentelemetry.io/proto/otlp](https://togithub.com/open-telemetry/opentelemetry-proto-go)
| `v1.2.0` -> `v1.3.1` |
[![age](https://developer.mend.io/api/mc/badges/age/go/go.opentelemetry.io%2fproto%2fotlp/v1.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/go.opentelemetry.io%2fproto%2fotlp/v1.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/go.opentelemetry.io%2fproto%2fotlp/v1.2.0/v1.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/go.opentelemetry.io%2fproto%2fotlp/v1.2.0/v1.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>open-telemetry/opentelemetry-proto-go
(go.opentelemetry.io/proto/otlp)</summary>

###
[`v1.3.1`](https://togithub.com/open-telemetry/opentelemetry-proto-go/releases/tag/v1.3.1)

[Compare
Source](https://togithub.com/open-telemetry/opentelemetry-proto-go/compare/v1.2.0...v1.3.1)

Release of the
[v1.3.1](https://togithub.com/open-telemetry/opentelemetry-proto/releases/tag/v1.3.1)
version of the OTLP including the new Profiles signal.

:warning: This release includes new experimental packages that do not
follow semantic versioning. See [the versioning
policy](https://togithub.com/open-telemetry/opentelemetry-proto-go?tab=readme-ov-file#versioning-policy)
for details.

##### What's Changed

- Bump google.golang.org/protobuf from 1.33.0 to 1.34.0 in /otlp by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/168](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/168)
- Bump google.golang.org/protobuf from 1.33.0 to 1.34.0 in /slim/otlp by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/169](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/169)
- Bump google.golang.org/grpc from 1.63.0 to 1.63.2 in /otlp by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/165](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/165)
- Add Versioning Policy to README by
[@&#8203;florianl](https://togithub.com/florianl) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/167](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/167)
- Bump google.golang.org/protobuf from 1.34.0 to 1.34.1 in /slim/otlp by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/171](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/171)
- Bump google.golang.org/protobuf from 1.34.0 to 1.34.1 in /otlp by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/172](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/172)
- Bump golang.org/x/net from 0.21.0 to 0.23.0 in /otlp by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/173](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/173)
- Bump google.golang.org/grpc from 1.63.2 to 1.64.0 in /otlp by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/174](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/174)
- Bump github.com/grpc-ecosystem/grpc-gateway/v2 from 2.19.1 to 2.20.0
in /otlp by [@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/175](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/175)
- Explain stability guarantees for experimental packages by
[@&#8203;MrAlias](https://togithub.com/MrAlias) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/177](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/177)
- Release v1.3.1 by [@&#8203;florianl](https://togithub.com/florianl) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/170](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/170)

##### New Contributors

- [@&#8203;florianl](https://togithub.com/florianl) made their first
contribution in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/167](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/167)

**Full Changelog**:
open-telemetry/opentelemetry-proto-go@v1.2.0...v1.3.1

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these
updates again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/open-telemetry/opentelemetry-go).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zOTMuMCIsInVwZGF0ZWRJblZlciI6IjM3LjQxMC4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJTa2lwIENoYW5nZWxvZyIsImRlcGVuZGVuY2llcyJdfQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
MrAlias referenced this pull request in open-telemetry/opentelemetry-go-contrib Jun 17, 2024
)

[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[go.opentelemetry.io/proto/otlp](https://togithub.com/open-telemetry/opentelemetry-proto-go)
| `v1.2.0` -> `v1.3.1` |
[![age](https://developer.mend.io/api/mc/badges/age/go/go.opentelemetry.io%2fproto%2fotlp/v1.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/go.opentelemetry.io%2fproto%2fotlp/v1.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/go.opentelemetry.io%2fproto%2fotlp/v1.2.0/v1.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/go.opentelemetry.io%2fproto%2fotlp/v1.2.0/v1.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>open-telemetry/opentelemetry-proto-go
(go.opentelemetry.io/proto/otlp)</summary>

###
[`v1.3.1`](https://togithub.com/open-telemetry/opentelemetry-proto-go/releases/tag/v1.3.1)

[Compare
Source](https://togithub.com/open-telemetry/opentelemetry-proto-go/compare/v1.2.0...v1.3.1)

Release of the
[v1.3.1](https://togithub.com/open-telemetry/opentelemetry-proto/releases/tag/v1.3.1)
version of the OTLP including the new Profiles signal.

:warning: This release includes new experimental packages that do not
follow semantic versioning. See [the versioning
policy](https://togithub.com/open-telemetry/opentelemetry-proto-go?tab=readme-ov-file#versioning-policy)
for details.

##### What's Changed

- Bump google.golang.org/protobuf from 1.33.0 to 1.34.0 in /otlp by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/168](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/168)
- Bump google.golang.org/protobuf from 1.33.0 to 1.34.0 in /slim/otlp by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/169](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/169)
- Bump google.golang.org/grpc from 1.63.0 to 1.63.2 in /otlp by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/165](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/165)
- Add Versioning Policy to README by
[@&#8203;florianl](https://togithub.com/florianl) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/167](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/167)
- Bump google.golang.org/protobuf from 1.34.0 to 1.34.1 in /slim/otlp by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/171](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/171)
- Bump google.golang.org/protobuf from 1.34.0 to 1.34.1 in /otlp by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/172](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/172)
- Bump golang.org/x/net from 0.21.0 to 0.23.0 in /otlp by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/173](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/173)
- Bump google.golang.org/grpc from 1.63.2 to 1.64.0 in /otlp by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/174](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/174)
- Bump github.com/grpc-ecosystem/grpc-gateway/v2 from 2.19.1 to 2.20.0
in /otlp by [@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/175](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/175)
- Explain stability guarantees for experimental packages by
[@&#8203;MrAlias](https://togithub.com/MrAlias) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/177](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/177)
- Release v1.3.1 by [@&#8203;florianl](https://togithub.com/florianl) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/170](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/170)

##### New Contributors

- [@&#8203;florianl](https://togithub.com/florianl) made their first
contribution in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/167](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/167)

**Full Changelog**:
open-telemetry/opentelemetry-proto-go@v1.2.0...v1.3.1

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these
updates again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/open-telemetry/opentelemetry-go-contrib).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zOTMuMCIsInVwZGF0ZWRJblZlciI6IjM3LjQxMC4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJTa2lwIENoYW5nZWxvZyIsImRlcGVuZGVuY2llcyJdfQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
OrHayat referenced this pull request in OrHayat/opentelemetry-go Jun 23, 2024
…en-telemetry#5505)

[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[go.opentelemetry.io/proto/otlp](https://togithub.com/open-telemetry/opentelemetry-proto-go)
| `v1.2.0` -> `v1.3.1` |
[![age](https://developer.mend.io/api/mc/badges/age/go/go.opentelemetry.io%2fproto%2fotlp/v1.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/go.opentelemetry.io%2fproto%2fotlp/v1.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/go.opentelemetry.io%2fproto%2fotlp/v1.2.0/v1.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/go.opentelemetry.io%2fproto%2fotlp/v1.2.0/v1.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>open-telemetry/opentelemetry-proto-go
(go.opentelemetry.io/proto/otlp)</summary>

###
[`v1.3.1`](https://togithub.com/open-telemetry/opentelemetry-proto-go/releases/tag/v1.3.1)

[Compare
Source](https://togithub.com/open-telemetry/opentelemetry-proto-go/compare/v1.2.0...v1.3.1)

Release of the
[v1.3.1](https://togithub.com/open-telemetry/opentelemetry-proto/releases/tag/v1.3.1)
version of the OTLP including the new Profiles signal.

:warning: This release includes new experimental packages that do not
follow semantic versioning. See [the versioning
policy](https://togithub.com/open-telemetry/opentelemetry-proto-go?tab=readme-ov-file#versioning-policy)
for details.

##### What's Changed

- Bump google.golang.org/protobuf from 1.33.0 to 1.34.0 in /otlp by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/168](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/168)
- Bump google.golang.org/protobuf from 1.33.0 to 1.34.0 in /slim/otlp by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/169](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/169)
- Bump google.golang.org/grpc from 1.63.0 to 1.63.2 in /otlp by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/165](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/165)
- Add Versioning Policy to README by
[@&#8203;florianl](https://togithub.com/florianl) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/167](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/167)
- Bump google.golang.org/protobuf from 1.34.0 to 1.34.1 in /slim/otlp by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/171](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/171)
- Bump google.golang.org/protobuf from 1.34.0 to 1.34.1 in /otlp by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/172](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/172)
- Bump golang.org/x/net from 0.21.0 to 0.23.0 in /otlp by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/173](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/173)
- Bump google.golang.org/grpc from 1.63.2 to 1.64.0 in /otlp by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/174](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/174)
- Bump github.com/grpc-ecosystem/grpc-gateway/v2 from 2.19.1 to 2.20.0
in /otlp by [@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/175](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/175)
- Explain stability guarantees for experimental packages by
[@&#8203;MrAlias](https://togithub.com/MrAlias) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/177](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/177)
- Release v1.3.1 by [@&#8203;florianl](https://togithub.com/florianl) in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/170](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/170)

##### New Contributors

- [@&#8203;florianl](https://togithub.com/florianl) made their first
contribution in
[https://github.com/open-telemetry/opentelemetry-proto-go/pull/167](https://togithub.com/open-telemetry/opentelemetry-proto-go/pull/167)

**Full Changelog**:
open-telemetry/opentelemetry-proto-go@v1.2.0...v1.3.1

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these
updates again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/open-telemetry/opentelemetry-go).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zOTMuMCIsInVwZGF0ZWRJblZlciI6IjM3LjQxMC4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJTa2lwIENoYW5nZWxvZyIsImRlcGVuZGVuY2llcyJdfQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants