Skip to content

Versioning doc update#811

Merged
lalitb merged 2 commits intoopen-telemetry:mainfrom
lalitb:version-doc
Jun 1, 2021
Merged

Versioning doc update#811
lalitb merged 2 commits intoopen-telemetry:mainfrom
lalitb:version-doc

Conversation

@lalitb
Copy link
Copy Markdown
Member

@lalitb lalitb commented Jun 1, 2021

Changes

Please provide a brief description of the changes here.

Update Versioning.md for:

  • Clarity on release policy as we would have a single release package containing SDK, API, and all exporters.
  • Clarity on versioning, as we have a single version for the entire release.
  • Clarity on ABI compatibility vs ABI breaking across releases.

For significant contributions please make sure you have completed the following items:

  • CHANGELOG.md updated for non-trivial changes
  • Unit tests have been added
  • Changes in public API reviewed

@lalitb lalitb requested a review from a team June 1, 2021 10:17
@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 1, 2021

Codecov Report

Merging #811 (08669d9) into main (f793e6e) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #811   +/-   ##
=======================================
  Coverage   96.19%   96.19%           
=======================================
  Files         153      153           
  Lines        6444     6444           
=======================================
  Hits         6198     6198           
  Misses        246      246           

Copy link
Copy Markdown
Member

@reyang reyang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@lalitb lalitb merged commit 5767f8e into open-telemetry:main Jun 1, 2021
Comment thread Versioning.md
* The API is header only, and uses ABI compliant interfaces. However, ABI stability
is not guaranteed for SDK.
* In case of ABI breaking changes, a new `inline namespace` version will
be introduced, and the existing linked applications can continue using the older version
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we give an example here on inline namespace?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry seems i missed this comment. ABI versioning using inline namespace is handled here in the code:

#define OPENTELEMETRY_BEGIN_NAMESPACE \
namespace opentelemetry { inline namespace OPENTELEMETRY_CONCAT(v, OPENTELEMETRY_ABI_VERSION_NO) {
. Should I be adding reference to this ?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I think we could add a reference in the next doc update.

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.

3 participants