Skip to content

Commit abc7281

Browse files
authored
Migrate from master to main : fix master branch references (#927)
1 parent f198a54 commit abc7281

10 files changed

+40
-43
lines changed

docs/Coding style.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -186,5 +186,5 @@ this order:
186186
- Do white-space-only changes in a separate commit for clarity (null
187187
output for `git diff -w` etc.).
188188
- Squash small fixes and code-review changes into original commits.
189-
- Integrate changes from development branches to `master` using rebase
189+
- Integrate changes from development branches to `main` using rebase
190190
and fast-forward merge.

docs/List-of-OSS-Components.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,19 @@ These are the Open Source components used by Microsoft 1DS / C++ Client Telemetr
66

77
ZLIB DATA COMPRESSION LIBRARY.
88

9-
SDK maintains its own snapshot of the mainline ZLib with some Intel architecture performance optimizations [here](https://github.com/microsoft/cpp_client_telemetry/tree/master/zlib).
9+
SDK maintains its own snapshot of the mainline ZLib with some Intel architecture performance optimizations [here](../zlib).
1010

1111
## [SQLite](https://www.sqlite.org/index.html)
1212

1313
SQLite is a C-language library that implements a small, fast, self-contained, high-reliability, full-featured, SQL database engine.
1414

15-
SDK maintains its own snapshot of the mainline SQLite, which is used for Windows builds [here](https://github.com/microsoft/cpp_client_telemetry/tree/master/sqlite). Other platforms use platform-provided SQLite.
15+
SDK maintains its own snapshot of the mainline SQLite, which is used for Windows builds [here](../sqlite). Other platforms use platform-provided SQLite.
1616

1717
## [nlohmann/json](https://github.com/nlohmann/json)
1818

1919
JSON for Modern C++.
2020

21-
SDK maintains its own snapshot of the mainline `nlohmann/json` header-only library [here](https://github.com/microsoft/cpp_client_telemetry/blob/master/lib/include/mat/json.hpp).
21+
SDK maintains its own snapshot of the mainline `nlohmann/json` header-only library [here](../lib/include/mat/json.hpp).
2222

2323
## [libcurl](https://curl.haxx.se/libcurl/)
2424

@@ -37,12 +37,12 @@ Google's C++ benchmarking framework. Used only for tests and not included in pro
3737
## [Tony Million Reachability Framework](https://github.com/tonymillion/Reachability)
3838

3939
Reachability is a drop-in replacement for Apple's Reachability class. It is ARC-compatible, and it uses the new GCD methods to notify of network interface changes.
40-
SDK maintains its own snapshot of the mainline `tonymillion/Reachability` [here](https://github.com/microsoft/cpp_client_telemetry/tree/master/third_party/Reachability). This code is not used nor included in the build of non-Apple OS.
40+
SDK maintains its own snapshot of the mainline `tonymillion/Reachability` [here](../third_party/Reachability). This code is not used nor included in the build of non-Apple OS.
4141

4242
## SHA-1 by Steve Reid
4343

4444
Classic implementation of SHA-1 (Public Domain).
45-
SDK maintains its own snapshot of it [here](https://github.com/microsoft/cpp_client_telemetry/blob/master/third_party/sha1/sha1.c).
45+
SDK maintains its own snapshot of it [here](../third_party/sha1/sha1.c).
4646
Note that this component is not included or compiled into any of the shipable bits of SDK. It is included for internal developer debug builds only.
4747
For example, SHA-1 may be used to calculate destination ETW Provider GUID based on ETW Provider name on Windows OS in developer trace tooling / instrumentation.
4848

docs/cpp-start-android.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You will ideally build the SDK using the same versions of the Android SDK, NDK,
1212

1313
The Gradle wrapper in ```android_build``` builds two modules, ```app``` and ```maesdk```. The ```maesdk``` module is the SDK packaged as an AAR, with both the Java and C++ components included. The AAR includes C++ shared libraries for four ABIs (two ARM ABIs for devices and two Intel ABIs for the emulator). Android Gradle (as usual) supports debug and release builds, and the Gradle task ```maesdk:assemble``` should build both flavors of AAR.
1414

15-
On Android, there are two database implementations to choose from. By default (the master branch on Github), the SDK will use the Android-supported androidx.Room database package. This reduces APK size because we don't need to compile and link in a copy of SQLite in native code (SQLite is hundreds of kB per ABI of APK file size). Room does have a slight CPU performance disadvantage since database transactions cross the JNI boundary when native code uses it. If you wish to change from Room to the native SQLite implementation, you should change the two module ```build.gradle``` files (app and maesdk). In those files, you will see an argument to CMake to select Room: ```"-DUSE_ROOM=1"```. Change this to ```"-DUSE_ROOM=0``` to select the native SQLite.
15+
On Android, there are two database implementations to choose from. By default (the main branch on Github), the SDK will use the Android-supported androidx.Room database package. This reduces APK size because we don't need to compile and link in a copy of SQLite in native code (SQLite is hundreds of kB per ABI of APK file size). Room does have a slight CPU performance disadvantage since database transactions cross the JNI boundary when native code uses it. If you wish to change from Room to the native SQLite implementation, you should change the two module ```build.gradle``` files (app and maesdk). In those files, you will see an argument to CMake to select Room: ```"-DUSE_ROOM=1"```. Change this to ```"-DUSE_ROOM=0``` to select the native SQLite.
1616

1717
The Room database implementation adds one additional initialization requirement, since it needs a pointer to the JVM and an object reference to the application context. See below (4.5) for the required call to either ```connectContext``` (in Java) or ```ConnectJVM``` (in C++) to set this up.
1818

@@ -137,9 +137,9 @@ LogManager::FlushAndTeardown();
137137

138138
You're done! You can now compile and run your app, and it will send a telemetry event using your ingestion key to your tenant.
139139

140-
Note that it is possible to use more than one log manager. See [examples/cpp/SampleCppLogManagers](https://github.com/microsoft/cpp_client_telemetry/tree/master/examples/cpp/SampleCppLogManagers) for a sample implementation.
140+
Note that it is possible to use more than one log manager. See [examples/cpp/SampleCppLogManagers](../examples/cpp/SampleCppLogManagers) for a sample implementation.
141141

142-
Please refer to [EventSender](https://github.com/microsoft/cpp_client_telemetry/tree/master/examples/cpp/EventSender) sample for more details. Other sample apps can be found [here](https://github.com/microsoft/cpp_client_telemetry/tree/master/examples/cpp/). The lib/android_build gradle wrappers will use the Android gradle plugin, and that in turn will use CMake/nmake to build C++ object files.
142+
Please refer to [EventSender](../examples/cpp/EventSender) sample for more details. Other sample apps can be found [here](../examples/cpp/). The lib/android_build gradle wrappers will use the Android gradle plugin, and that in turn will use CMake/nmake to build C++ object files.
143143

144144
## 4. Device File Locations
145145

docs/cpp-start-ios.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,4 @@ LogManager::FlushAndTeardown();
5858
5959
You're done! You can now compile and run your app, and it will send a telemetry event using your ingestion key to your tenant.
6060
61-
Please refer to [EventSender](https://github.com/microsoft/cpp_client_telemetry/tree/master/examples/cpp/EventSender) sample for more details. Other sample apps can be found [here](https://github.com/microsoft/cpp_client_telemetry/tree/master/examples/cpp/). All of our SDK samples require CMake build system, but you may consume the SDK using any other alternate build system of your choice (GNU Make, gn, etc.).
61+
Please refer to [EventSender](../examples/cpp/EventSender) sample for more details. Other sample apps can be found [here](../examples/cpp/). All of our SDK samples require CMake build system, but you may consume the SDK using any other alternate build system of your choice (GNU Make, gn, etc.).

docs/cpp-start-linux.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,4 @@ LogManager::FlushAndTeardown();
6262
6363
You're done! You can now compile and run your app, and it will send a telemetry event using your ingestion key to your tenant.
6464
65-
Please refer to [EventSender](https://github.com/microsoft/cpp_client_telemetry/tree/master/examples/cpp/EventSender) sample for more details. Other sample apps can be found [here](https://github.com/microsoft/cpp_client_telemetry/tree/master/examples/cpp/). All of our SDK samples require CMake build system, but you may consume the SDK using any other alternate build system of your choice (GNU Make, gn, etc.).
65+
Please refer to [EventSender](../examples/cpp/EventSender) sample for more details. Other sample apps can be found [here](../examples/cpp/). All of our SDK samples require CMake build system, but you may consume the SDK using any other alternate build system of your choice (GNU Make, gn, etc.).

docs/cpp-start-windows.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ depending on what Visual Studio version you are using.
6868

6969
## **Instrument your code to send a telemetry event**
7070

71-
- Make sure you added the [public SDK headers](https://github.com/microsoft/cpp_client_telemetry/tree/master/lib/include/public) to [your project include path](https://docs.microsoft.com/en-us/cpp/build/reference/c-cpp-prop-page?view=msvc-160#additional-include-directories).
71+
- Make sure you added the [public SDK headers](../lib/include/public) to [your project include path](https://docs.microsoft.com/en-us/cpp/build/reference/c-cpp-prop-page?view=msvc-160#additional-include-directories).
7272
- Make sure you added the SDK that you built, e.g. `ClientTelemetry.lib` to [your project library path](https://docs.microsoft.com/en-us/cpp/build/reference/vcpp-directories-property-page).
7373

7474
### 1. Include the main 1DS C++ SDK header file in your main.cpp by adding the following statement to the top of your app's implementation file
@@ -113,6 +113,6 @@ More examples can be found under *examples* folder.
113113
- [CMake Tutorial](https://cmake.org/cmake/help/latest/guide/tutorial/index.html)
114114
- [Runtime Library Variants: static vs dynamic runtime](https://www.oreilly.com/library/view/c-cookbook/0596007612/ch01s24.html)
115115
116-
If you encounter troubles building the project, please refer to our CI/Build pipeline settings [here](https://github.com/microsoft/cpp_client_telemetry/blob/master/.github/workflows/build-windows-vs2019.yaml). This pipeline runs on a standard GitHub image with a standard Visual Studio 2019 installation. If you are still stuck, please log your build question as [GitHub issue](https://github.com/microsoft/cpp_client_telemetry/issues) with labels `question` and `build infra`. We would be glad to help and adjust documentation accordingly.
116+
If you encounter troubles building the project, please refer to our CI/Build pipeline settings [here](../.github/workflows/build-windows-vs2019.yaml). This pipeline runs on a standard GitHub image with a standard Visual Studio 2019 installation. If you are still stuck, please log your build question as [GitHub issue](https://github.com/microsoft/cpp_client_telemetry/issues) with labels `question` and `build infra`. We would be glad to help and adjust documentation accordingly.
117117
118118
If you find that some documentation is incorrect, please send a PR to fix it. We ❤️ community contributions!

docs/dev-branch-process.md

+7-9
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,23 @@
44

55
Naming convention is simple and straightforward.
66

7-
- **Master (master)** is the default branch available in the Git repository for the `current` release. Current SDK release is `v3.x`. This branch should be stable all the time and won’t allow any direct check-in. You can only merge it after code review. All team members are responsible for keeping the master stable and up-to-date.
7+
- **Main (main)** is the default branch available in the Git repository for the `current` release. Current SDK release is `v3.x`. This branch should be stable all the time and won’t allow any direct check-in. You can only merge it after code review. All team members are responsible for keeping the main stable and up-to-date.
88

9-
- **Development (dev)** is the main development branch for the next major release `v4.x`. The dev branch’s idea is to make changes in it and restrict the developers from making any changes in the master branch directly. Changes in the dev branch undergo reviews. When ready, the branch will be fully promoted to `master`.
9+
- **Development (dev)** is the main development branch for the next major release `v4.x`. The dev branch’s idea is to make changes in it and restrict the developers from making any changes in the main branch directly. Changes in the dev branch undergo reviews. When ready, the branch will be fully promoted to `main`.
1010

11-
## `master` branch renaming to `main` would commence in 2021
12-
13-
It is planned for `v4.x` branch to coincide with renaming of the `master` branch to `main`. Many communities, both on GitHub and in the wider Git community, are considering renaming the default branch name of their repository from `master`. We are also committed to gradually rename the default branch of our repository from `master` to `main`.
11+
- **Master (master)** is the copy of `main` branch created after migration of original `master` branch to `main` branch. The branch is temporarily created to ensure that builds for projects using this repo in their CI pipeline doesn't start breaking immediately after migration. This newly created copy is locked against any new commits, and would be deleted in future once all the teams hae migrated their CI pipelines to build from `main`.
1412

1513
## Continuous Integration on `dev` branch
1614

17-
All of the existing tests are enabled on both `master` and `dev` branches. While implementing any refactoring changes, please adjust all tests accordingly.
15+
All of the existing tests are enabled on both `main` and `dev` branches. While implementing any refactoring changes, please adjust all tests accordingly.
1816

1917
## Documenting Feature and API changes
2018

21-
Please use Markdown format to document any API changes from v3.x to v4.x in [docs directory](https://github.com/microsoft/cpp_client_telemetry/tree/master/docs).
19+
Please use Markdown format to document any API changes from v3.x to v4.x in [docs directory](../docs).
2220

2321
## Release labels for multiple versions
2422

25-
While the `master` (`main`) branch contains linear history of all releases and associated git tags, it may be practical to branch-off specific releases for use in concrete products.
23+
While the `main` branch contains linear history of all releases and associated git tags, it may be practical to branch-off specific releases for use in concrete products.
2624

2725
Sometimes a product may require a feature to be added on top of old long-term supported release.
2826

@@ -38,7 +36,7 @@ All feature work made by maintainers on latest release (or `dev` branch) will no
3836
Commmitters use their best judgment if they'd like to backport a feature.
3937

4038
In case of a backport of a new feature to old release, `release/$product/v3.x.y` branch would be created.
41-
Old release long-term support branches should never be full-promoted back into `dev` or `master` (`main`).
39+
Old release long-term support branches should never be full-promoted back into `dev` or `main`).
4240

4341
Continuous Integration is enabled on `release/*` branches.
4442

docs/start_macOS_iOS.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 1DS C++ SDK iOS/macOS Podspec Onboarding
22

3-
This tutorial guides you through the process of integrating the [1DS SDK](https://github.com/microsoft/cpp_client_telemetry) into your existing iOS and macOS app. Here we consume the [Msblox Podspec]() and published [Obj-C Wrappers](https://github.com/microsoft/cpp_client_telemetry/tree/master/wrappers/obj-c). If you want to consume the C++ Library directly, please follow the tutorials at [Getting started - iOS](https://github.com/microsoft/cpp_client_telemetry/blob/master/docs/cpp-start-ios.md) and [Getting Started - Mac OS X](https://github.com/microsoft/cpp_client_telemetry/blob/master/docs/cpp-start-macosx.md)
3+
This tutorial guides you through the process of integrating the [1DS SDK](https://github.com/microsoft/cpp_client_telemetry) into your existing iOS and macOS app. Here we consume the [Msblox Podspec]() and published [Obj-C Wrappers](../wrappers/obj-c). If you want to consume the C++ Library directly, please follow the tutorials at [Getting started - iOS](./cpp-start-ios.md) and [Getting Started - Mac OS X](./cpp-start-macosx.md)
44

55
## Add OneDsCppSdk Cocoapod to the Podfile
66

docs/versioning.md

+16-17
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ If urgent critical fix is needed, then additional release could be published ahe
77

88
SDK utilizes [SemVer 2.0](https://semver.org/) for its versioning.
99

10-
SDK version as of December 2020 is [v3.4.343](https://github.com/microsoft/cpp_client_telemetry/releases/tag/v3.4.343),
10+
SDK version as of September 2021 is [v3.5.200](https://github.com/microsoft/cpp_client_telemetry/releases/tag/v3.5.200),
1111
where:
1212
- `VER_MAJOR=3`
13-
- `VER_MINOR=4`
14-
- `VER_PATCH=343`
15-
with [Version.hpp](https://github.com/microsoft/cpp_client_telemetry/blob/master/lib/include/public/Version.hpp)
13+
- `VER_MINOR=5`
14+
- `VER_PATCH=200`
15+
with [Version.hpp](../lib/include/public/Version.hpp)
1616
containing runtime-accessible version information. `Version.hpp` file is auto-generated.
1717

1818
Version details:
@@ -21,14 +21,14 @@ Version details:
2121
- `VER_PATCH` is a day number of the year.
2222

2323
`Version.hpp` file is generated during Release publishing stage using cross-platform
24-
[gen-version](https://github.com/microsoft/cpp_client_telemetry/blob/master/tools/version.js) script written in `node.js`.
24+
[gen-version](../tools/version.js) script written in `node.js`.
2525

2626
## Release Process
2727

2828
SDK maintainer preparing the release must:
2929
- run `tools/gen-version.cmd` on Windows (or `tools/gen-version.sh` on POSIX) to generate the `Version.hpp` file
3030
- commit the contents of `Version.hpp`
31-
- send a PR to merge it in the `master` branch
31+
- send a PR to merge it in the `main` branch
3232
- use [GitHub Release Management Tab](https://github.com/microsoft/cpp_client_telemetry/releases/new)
3333
to create a corresponding `v3.x.x` release tag with release notes
3434

@@ -70,7 +70,7 @@ maintainers must use their best judgement to decide on where MINOR increment is
7070

7171
C API is designed for plugins, or "SDK in SDK" scenarios and provides ABI stability guarantee.
7272

73-
C API is described in [mat.h](https://github.com/microsoft/cpp_client_telemetry/blob/master/lib/include/public/mat.h) C header.
73+
C API is described in [mat.h](../lib/include/public/mat.h) C header.
7474

7575
C API is forward-compatible and backwards-compatible: unsupported API calls are ignored and
7676
an error returned to the caller. Current version of C API is `3.1.0` with no immediate
@@ -79,22 +79,21 @@ with various products using C API. Adding new C functions to C API should warran
7979
of C API to version `3.2.0`. Since C API is rather stable and does not change frequently,
8080
it may be missing some features recently added to C++ API.
8181

82-
## Tentative Release schedule for 2021H1
82+
## Tentative Release schedule for 2021H2
8383

8484
Release tag | ETA Date | Branch
8585
-----------------|----------|--------
86-
v3.5.[1-31] | Jan 2021 | master
87-
v3.5.[32-59] | Feb 2021 | master
88-
v3.5.[60-90] | Mar 2021 | master
89-
v3.6.[91-120] | Apr 2021 | master
90-
v3.6.[121-151] | May 2021 | master
91-
v3.6.[152-181] | Jun 2021 | master
86+
v3.5.[240-270] | Sept 2021 | main
87+
v3.5.[271-300] | Oct 2021 | main
88+
v3.5.[301-330] | Nov 2021 | main
89+
v3.6.[1-30] | Dec 2021 | main
90+
9291

9392
NOTE: although this tentative schedule lists `v3.5` or `v3.6`, we live in agile environment.
94-
Due to various arising practical needs it may be necessary to update `VER_MINOR` to `6`, `7`,
95-
`8`, etc. in case of a need to add some new major feature or new protocol to SDK.
93+
Due to various arising practical needs it may be necessary to update `VER_MINOR` to `7`, `8`,
94+
`9`, etc. in case of a need to add some new major feature or new protocol to SDK.
9695

97-
## Release schedule for 2021H2
96+
## Release schedule for 2022H1
9897

9998
A separate feature branch may be needed to accommodate the integration with
10099
[OpenTelemetry C++ SDK](https://github.com/open-telemetry/opentelemetry-cpp).

0 commit comments

Comments
 (0)