Skip to content

Commit 652b49a

Browse files
authored
Add changelog at api and sdk level, abi version for sdk (#451)
1 parent 39679b2 commit 652b49a

File tree

5 files changed

+66
-4
lines changed

5 files changed

+66
-4
lines changed

CHANGELOG.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,10 @@ Increment the:
1313

1414

1515
## [Unreleased]
16+
17+
## [0.0.1] 2020-12-16
1618
### Added
17-
* Trace API and SDK
19+
* Trace API and SDK experimental
1820
* OTLP Exporter
1921
### Changed
2022
### Removed

api/CHANGELOG.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Release History: opentelemetry-api
2+
3+
All notable changes to the api project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## Guideline to update the version:
9+
Increment the:
10+
- MAJOR version when you make incompatible API/ABI changes,
11+
- MINOR version when you add functionality in a backwards compatible manner, and
12+
- PATCH version when you make backwards compatible bug fixes.
13+
14+
15+
## [Unreleased]
16+
17+
## [0.0.1] 2020-12-16
18+
### Added
19+
* Trace API experimental
20+
### Changed
21+
### Removed

buildscripts/pre_release.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ if [ ! -f $changelog_file ]; then
4545
exit 1
4646
fi
4747

48-
if [ ! grep -q "## [Unreleased]" $changelog_file ]; then
48+
if [ ! grep -q "^\#\# \[Unreleased\]$" $changelog_file ]; then
4949
echo "Error: $changelog_file doesn't contain Unreleased information. Please update the file with changes and run this script again."
5050
exit 1
5151
fi
@@ -59,12 +59,12 @@ fi
5959
# update CHANGELOG.md
6060
date=$(date '+%Y-%m-%d')
6161
sed -i "/\#\# \[Unreleased\]/a\\ \n\#\# \[${tag}\] ${date}" $changelog_file
62-
if [$? -ne 0]; then
62+
if [ $? -ne 0 ]; then
6363
echo "Error: Cannot update CHANGELOG.md file. Update it manually, create the ${tag} and push changes to upstream"
6464
exit 1
6565
fi
6666

67-
git add .
67+
git add CHANGELOG.md
6868
git commit -m "Prepare for releasing ${tag}"
6969

7070
echo "Now validate the chages using git diff master, create the ${tag} and push changes to upstream"

sdk/CHANGELOG.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Release History: opentelemetry-sdk
2+
3+
All notable changes to the sdk project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## Guideline to update the version:
9+
Increment the:
10+
- MAJOR version when you make incompatible API/ABI changes,
11+
- MINOR version when you add functionality in a backwards compatible manner, and
12+
- PATCH version when you make backwards compatible bug fixes.
13+
14+
15+
## [Unreleased]
16+
17+
## [0.0.1] 2020-12-16
18+
### Added
19+
* Trace SDK experimental
20+
* OTLP Exporter
21+
### Changed
22+
### Removed

sdk/include/opentelemetry/sdk/version/version.h

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,22 @@
11
#pragma once
22

3+
#include "opentelemetry/detail/preprocessor.h"
4+
5+
#define OPENTELEMETRY_SDK_ABI_VERSION_NO 0
6+
#define OPENTELEMETRY_SDK_VERSION "0.0.1"
7+
#define OPENTELEMETRY_SDK_ABI_VERSION OPENTELEMETRY_STRINGIFY(OPENTELEMETRY_SDK_ABI_VERSION_NO)
8+
9+
// clang-format off
10+
#define OPENTELEMETRY_SDK_BEGIN_NAMESPACE \
11+
namespace opentelemetry { namespace sdk { inline namespace OPENTELEMETRY_CONCAT(v, OPENTELEMETRY_SDK_ABI_VERSION_NO) {
12+
13+
#define OPENTELEMETRY_SDK_END_NAMESPACE \
14+
}}}
15+
16+
#define OPENTELEMETRY_SDK_NAMESPACE opentelemetry :: sdk :: OPENTELEMETRY_CONCAT(v, OPENTELEMETRY_SDK_ABI_VERSION_NO)
17+
18+
// clang-format on
19+
320
#include "opentelemetry/version.h"
421

522
OPENTELEMETRY_BEGIN_NAMESPACE

0 commit comments

Comments
 (0)