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

Mark opentelemetry-proto repo 1.0 #456

Closed
7 tasks done
tigrannajaryan opened this issue Apr 20, 2023 · 17 comments
Closed
7 tasks done

Mark opentelemetry-proto repo 1.0 #456

tigrannajaryan opened this issue Apr 20, 2023 · 17 comments

Comments

@tigrannajaryan
Copy link
Member

tigrannajaryan commented Apr 20, 2023

This is the checklist we want to go through before marking this repo 1.0.

All issues must be resolved, PRs must be merged or closed. Please add any items you think are missing to this list.

@jmacd
Copy link
Contributor

jmacd commented May 2, 2023

For the record, I think we should keep every existing enum as-is and declare 1.0.
I do not support #433 and I do not support #423.

@tigrannajaryan
Copy link
Member Author

@open-telemetry/specs-approvers please add any other items to the checklist above that you think are needed before we mark this repo 1.0.

tigrannajaryan added a commit to tigrannajaryan/opentelemetry-proto that referenced this issue May 8, 2023
We merged the open-telemetry#432
without clarifying when exactly the guarantees start applying. The intent
was that the guarantees are needed for 1.0 release but we didn't make this
explicit.

We are now making this explicit and until 1.0 released we should be free
to fix the remaining known issues listed here:
open-telemetry#456

Once 1.0 release is made we can remove the [from 1.0.0] labels from the README.md.
bogdandrutu pushed a commit that referenced this issue May 9, 2023
We merged the #432
without clarifying when exactly the guarantees start applying. The intent
was that the guarantees are needed for 1.0 release but we didn't make this
explicit.

We are now making this explicit and until 1.0 released we should be free
to fix the remaining known issues listed here:
#456

Once 1.0 release is made we can remove the [from 1.0.0] labels from the README.md.
@marcalff
Copy link
Member

marcalff commented May 9, 2023

Please consider to add a VERSION file as well, per issue #434

(Not a spec approver, this is just a suggestion)

@tigrannajaryan
Copy link
Member Author

@open-telemetry/specs-approvers I went over the list of open issues and do not see anything else that can block the 1.0 that is not already on our checklist. If you think otherwise, please add to the list.

@carlosalberto
Copy link
Contributor

@tigrannajaryan I think we are ready to go (I mentioned this in this week's Spec call, and I see no further comments).

@tigrannajaryan
Copy link
Member Author

We are ready. I suggest releasing OTLP 0.20.0 now, then release 1.0.0 in 2 weeks to give time to notice any issues.

@tigrannajaryan
Copy link
Member Author

@open-telemetry/specs-approvers I prepared the draft release 1.0.0: https://github.com/open-telemetry/opentelemetry-proto/releases/tag/untagged-c53594e61f023c410cc4

Is there anything that needs to be changed in this repo before we hit the release button?

@bogdandrutu
Copy link
Member

One small comment related to this, is how are we going to allow adding of new signals after 1.0? Since we have these guarantees, any new signal is automatically stable? Are we going to have multiple versions? Would be good to understand that path for that, since there will be folks commenting that if we include that new signal in 1.0 you need to have it stable from the first release..

@tigrannajaryan
Copy link
Member Author

Good questions!

One small comment related to this, is how are we going to allow adding of new signals after 1.0?
Since we have these guarantees, any new signal is automatically stable?

No. We have a maturity table where signals are explicitly listed: https://github.com/open-telemetry/opentelemetry-proto#maturity-level

When adding a new signal we must also add a row in this table. New signals will get added as "Alpha" and then will mature over time.

Are we going to have multiple versions? Would be good to understand that path for that, since there will be folks commenting that if we include that new signal in 1.0 you need to have it stable from the first release..

No, I think we should stay on 1.0 for now. OTLP 2.0 will be either for breaking changes or when we want to add something so big that even though it does not break existing stuff we want to increase the major version number.

@open-telemetry/specs-approvers Do we feel that any of these needs to be recorded as a text in the README or in docs sub-directory and not just as a comment in this issue?

@bogdandrutu
Copy link
Member

I would like just a short sentence that the 1.0 artifact may include unstable/alpha components that can break

@tigrannajaryan
Copy link
Member Author

I would like just a short sentence that the 1.0 artifact may include unstable/alpha components that can break

@bogdandrutu see PR: #489

@tigrannajaryan
Copy link
Member Author

#489 is merged.

Last call before 1.0.0 goes out.

@bogdandrutu
Copy link
Member

@tigrannajaryan one more "nit" #490

@bogdandrutu
Copy link
Member

I think we are ready now, at least I have no more objections

@tigrannajaryan
Copy link
Member Author

v1.0.0 released: https://github.com/open-telemetry/opentelemetry-proto/releases/tag/v1.0.0

@marcalff
Copy link
Member

marcalff commented Jul 3, 2023

@tigrannajaryan

Please fix the CHANGELOG.

It reads:

## Unreleased

Full list of differences found in [this compare](https://github.com/open-telemetry/opentelemetry-proto/compare/v0.20.0...main).

## 0.20.0 - 2023-06-06

Full list of differences found in [this compare](https://github.com/open-telemetry/opentelemetry-proto/compare/v0.19.0...v0.20.0).

Expected:

## Unreleased

Full list of differences found in [this compare](https://github.com/open-telemetry/opentelemetry-proto/compare/v1.0.0...main).

## 1.0.0 - 2023-07-03

Full list of differences found in [this compare](https://github.com/open-telemetry/opentelemetry-proto/compare/v0.20.0...v1.0.0).

## 0.20.0 - 2023-06-06

Full list of differences found in [this compare](https://github.com/open-telemetry/opentelemetry-proto/compare/v0.19.0...v0.20.0).

@tigrannajaryan
Copy link
Member Author

@marcalff PR to update changelog #493

VinozzZ pushed a commit to VinozzZ/opentelemetry-proto that referenced this issue Jun 21, 2024
…metry#467)

We merged the open-telemetry#432
without clarifying when exactly the guarantees start applying. The intent
was that the guarantees are needed for 1.0 release but we didn't make this
explicit.

We are now making this explicit and until 1.0 released we should be free
to fix the remaining known issues listed here:
open-telemetry#456

Once 1.0 release is made we can remove the [from 1.0.0] labels from the README.md.
VinozzZ pushed a commit to VinozzZ/opentelemetry-proto that referenced this issue Jun 21, 2024
…metry#467)

We merged the open-telemetry#432
without clarifying when exactly the guarantees start applying. The intent
was that the guarantees are needed for 1.0 release but we didn't make this
explicit.

We are now making this explicit and until 1.0 released we should be free
to fix the remaining known issues listed here:
open-telemetry#456

Once 1.0 release is made we can remove the [from 1.0.0] labels from the README.md.
VinozzZ pushed a commit to VinozzZ/opentelemetry-proto that referenced this issue Jun 21, 2024
…metry#467)

We merged the open-telemetry#432
without clarifying when exactly the guarantees start applying. The intent
was that the guarantees are needed for 1.0 release but we didn't make this
explicit.

We are now making this explicit and until 1.0 released we should be free
to fix the remaining known issues listed here:
open-telemetry#456

Once 1.0 release is made we can remove the [from 1.0.0] labels from the README.md.
VinozzZ pushed a commit to VinozzZ/opentelemetry-proto that referenced this issue Jun 21, 2024
…metry#467)

We merged the open-telemetry#432
without clarifying when exactly the guarantees start applying. The intent
was that the guarantees are needed for 1.0 release but we didn't make this
explicit.

We are now making this explicit and until 1.0 released we should be free
to fix the remaining known issues listed here:
open-telemetry#456

Once 1.0 release is made we can remove the [from 1.0.0] labels from the README.md.
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

No branches or pull requests

5 participants