From f8c9a40be56533efe9d4c0c1dda240abb4c9b86d Mon Sep 17 00:00:00 2001 From: Ehsan Saei <71217171+esigo@users.noreply.github.com> Date: Tue, 5 Nov 2024 11:43:48 +0100 Subject: [PATCH 1/9] add devcontainer add devcontainer --- .devcontainer/Dockerfile.dev | 22 ++++++++++++++++++++++ .devcontainer/devcontainer.json | 19 +++++++++++++++++++ .github/dependabot.yml | 5 +++++ 3 files changed, 46 insertions(+) create mode 100644 .devcontainer/Dockerfile.dev create mode 100644 .devcontainer/devcontainer.json diff --git a/.devcontainer/Dockerfile.dev b/.devcontainer/Dockerfile.dev new file mode 100644 index 0000000000..f4dd9c6e06 --- /dev/null +++ b/.devcontainer/Dockerfile.dev @@ -0,0 +1,22 @@ +FROM otel/cpp_format_tools + +ARG GRPC_VERSION=v1.55.0 + +COPY ci/setup_googletest.sh /opt/ci/setup_googletest.sh +COPY ci/setup_ci_environment.sh /opt/ci/setup_ci_environment.sh +COPY ci/setup_cmake.sh /opt/ci/setup_cmake.sh +COPY ci/setup_grpc.sh /opt/ci/setup_grpc.sh + +RUN apt update && apt install -y wget \ + ninja-build \ + libcurl4-openssl-dev + +RUN bash /opt/ci/setup_ci_environment.sh \ + && bash /opt/ci/setup_cmake.sh \ + && bash /opt/ci/setup_googletest.sh \ + && bash /opt/ci/setup_grpc.sh -r ${GRPC_VERSION} + +ADD https://github.com/bazelbuild/bazelisk/releases/download/v1.22.1/bazelisk-linux-amd64 /usr/local/bin + +RUN git config --global core.autocrlf input \ + && chmod +x /usr/local/bin/bazelisk-linux-amd64 diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 0000000000..a36d47bb98 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,19 @@ +// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: +// https://github.com/microsoft/vscode-dev-containers/tree/v0.162.0/containers/javascript-node +{ + "name": "opentelemetry-cpp", + "build": { + "context": "..", + "dockerfile": "Dockerfile.dev", + "args": { "GRPC_VERSION": "v1.55.0" } + }, + // Set *default* container specific settings.json values on container create. + "settings": { + "terminal.integrated.shell.linux": "/bin/sh" + }, + "extensions": [ + "ms-vscode.cpptools" + ], + + "remoteUser": "root" +} diff --git a/.github/dependabot.yml b/.github/dependabot.yml index d907392962..5cfb4cb898 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -6,3 +6,8 @@ updates: interval: "daily" labels: - "GHA" + + - package-ecosystem: "devcontainers" + directory: "/" + schedule: + interval: daily From f395d908dc0e311b867edae4b3b1b8113e4010a7 Mon Sep 17 00:00:00 2001 From: Ehsan Saei <71217171+esigo@users.noreply.github.com> Date: Tue, 5 Nov 2024 13:03:41 +0100 Subject: [PATCH 2/9] grpc --- .devcontainer/Dockerfile.dev | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/.devcontainer/Dockerfile.dev b/.devcontainer/Dockerfile.dev index f4dd9c6e06..12027c15d2 100644 --- a/.devcontainer/Dockerfile.dev +++ b/.devcontainer/Dockerfile.dev @@ -5,16 +5,21 @@ ARG GRPC_VERSION=v1.55.0 COPY ci/setup_googletest.sh /opt/ci/setup_googletest.sh COPY ci/setup_ci_environment.sh /opt/ci/setup_ci_environment.sh COPY ci/setup_cmake.sh /opt/ci/setup_cmake.sh +COPY ci/install_abseil.sh /opt/ci/install_abseil.sh +COPY ci/install_protobuf.sh /opt/ci/install_protobuf.sh COPY ci/setup_grpc.sh /opt/ci/setup_grpc.sh +COPY ci/fix-abseil-cpp-issue-1536.patch /opt/ci/fix-abseil-cpp-issue-1536.patch RUN apt update && apt install -y wget \ ninja-build \ libcurl4-openssl-dev -RUN bash /opt/ci/setup_ci_environment.sh \ - && bash /opt/ci/setup_cmake.sh \ - && bash /opt/ci/setup_googletest.sh \ - && bash /opt/ci/setup_grpc.sh -r ${GRPC_VERSION} +RUN cd /opt/ci && bash setup_ci_environment.sh +RUN cd /opt/ci && bash setup_cmake.sh +RUN cd /opt && bash ci/setup_googletest.sh \ + && bash ci/install_abseil.sh \ + && bash ci/install_protobuf.sh \ + && bash ci/setup_grpc.sh -p protobuf -p abseil-cpp -r ${GRPC_VERSION} ADD https://github.com/bazelbuild/bazelisk/releases/download/v1.22.1/bazelisk-linux-amd64 /usr/local/bin From c40abb5d0af11351f305e9b6697ce656e2b30c05 Mon Sep 17 00:00:00 2001 From: Ehsan Saei <71217171+esigo@users.noreply.github.com> Date: Tue, 5 Nov 2024 18:40:17 +0000 Subject: [PATCH 3/9] gRPC --- .devcontainer/Dockerfile.dev | 19 ++++++++----------- .devcontainer/devcontainer.json | 11 ++++++++--- 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/.devcontainer/Dockerfile.dev b/.devcontainer/Dockerfile.dev index 12027c15d2..1fedad5396 100644 --- a/.devcontainer/Dockerfile.dev +++ b/.devcontainer/Dockerfile.dev @@ -1,25 +1,22 @@ FROM otel/cpp_format_tools ARG GRPC_VERSION=v1.55.0 +ARG PROTOBUF_VERSION=23.4 +ARG ABSEIL_CPP_VERSION=20240116.1 -COPY ci/setup_googletest.sh /opt/ci/setup_googletest.sh -COPY ci/setup_ci_environment.sh /opt/ci/setup_ci_environment.sh -COPY ci/setup_cmake.sh /opt/ci/setup_cmake.sh -COPY ci/install_abseil.sh /opt/ci/install_abseil.sh -COPY ci/install_protobuf.sh /opt/ci/install_protobuf.sh -COPY ci/setup_grpc.sh /opt/ci/setup_grpc.sh -COPY ci/fix-abseil-cpp-issue-1536.patch /opt/ci/fix-abseil-cpp-issue-1536.patch +ENV PROTOBUF_VERSION=${PROTOBUF_VERSION} +ENV ABSEIL_CPP_VERSION=${ABSEIL_CPP_VERSION} + +COPY ci /opt/ci RUN apt update && apt install -y wget \ ninja-build \ libcurl4-openssl-dev -RUN cd /opt/ci && bash setup_ci_environment.sh RUN cd /opt/ci && bash setup_cmake.sh +RUN cd /opt/ci && bash setup_ci_environment.sh RUN cd /opt && bash ci/setup_googletest.sh \ - && bash ci/install_abseil.sh \ - && bash ci/install_protobuf.sh \ - && bash ci/setup_grpc.sh -p protobuf -p abseil-cpp -r ${GRPC_VERSION} + && bash ci/setup_grpc.sh -r ${GRPC_VERSION} ADD https://github.com/bazelbuild/bazelisk/releases/download/v1.22.1/bazelisk-linux-amd64 /usr/local/bin diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index a36d47bb98..0e0ac82eae 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -5,14 +5,19 @@ "build": { "context": "..", "dockerfile": "Dockerfile.dev", - "args": { "GRPC_VERSION": "v1.55.0" } + "args": { + "GRPC_VERSION": "v1.55.0", + "PROTOBUF_VERSION": "23.4", + "ABSEIL_CPP_VERSION":"20240116.1" + } }, - // Set *default* container specific settings.json values on container create. "settings": { "terminal.integrated.shell.linux": "/bin/sh" }, "extensions": [ - "ms-vscode.cpptools" + "ms-vscode.cpptools", + "ms-azuretools.vscode-docker", + "ms-vscode.cpptools-extension-pack" ], "remoteUser": "root" From ce1e82a8bfe71ae814f6e1d219515b94560ea6ce Mon Sep 17 00:00:00 2001 From: Ehsan Saei <71217171+esigo@users.noreply.github.com> Date: Wed, 6 Nov 2024 21:43:26 +0100 Subject: [PATCH 4/9] add documentation --- .devcontainer/Dockerfile.dev | 3 ++ .devcontainer/devcontainer.json | 2 + CONTRIBUTING.md | 65 +++++++++++++++++++++++++++++++++ 3 files changed, 70 insertions(+) diff --git a/.devcontainer/Dockerfile.dev b/.devcontainer/Dockerfile.dev index 1fedad5396..7e24cb8088 100644 --- a/.devcontainer/Dockerfile.dev +++ b/.devcontainer/Dockerfile.dev @@ -1,3 +1,6 @@ +# Copyright The OpenTelemetry Authors +# SPDX-License-Identifier: Apache-2.0 + FROM otel/cpp_format_tools ARG GRPC_VERSION=v1.55.0 diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 0e0ac82eae..8615497085 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,3 +1,5 @@ +// Copyright The OpenTelemetry Authors +// SPDX-License-Identifier: Apache-2.0 // For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: // https://github.com/microsoft/vscode-dev-containers/tree/v0.162.0/containers/javascript-node { diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 95b4e226f8..3036a0fa61 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,6 +60,71 @@ bazel build //examples/simple:example_simple bazel-bin/examples/simple/example_simple ``` +### DevContainer Setup for Project + +This guide provides instructions on how to set up and use the development container (`devcontainer`) environment to streamline testing and development for this project. With the DevContainer, you can work in a consistent environment configured with all the necessary dependencies and tools. + +#### Prerequisites + +Before getting started, ensure you have the following installed: + +1. **Docker**: DevContainers require Docker for containerization. +2. **Visual Studio Code (VSCode)** with the **Remote - Containers** extension. + +#### Getting Started + +1. **Open the Project in DevContainer**: + - Open the project in VSCode. + - When prompted to "Reopen in Container," select this option. If you’re not prompted, you can manually open the container by selecting **Remote-Containers: Reopen in Container** from the command palette (`F1` or `Ctrl+Shift+P`). + +2. **Container Setup**: The DevContainer environment will automatically build based on the configuration files provided (e.g., `.devcontainer/devcontainer.json`). This setup will install required dependencies, tools, and environment variables needed for the project. + +#### Available Commands + +Once inside the DevContainer, you can use the following commands to run tests and CI workflows. + +#### 1. Run Tests with Bazelisk + +To run tests with Bazelisk using specific compilation options, use: + +```bash +bazelisk-linux-amd64 test --copt=-DENABLE_LOGS_PREVIEW --test_output=errors --cache_test_results=no --copt=-DENABLE_TEST //exporters/otlp/... +``` + +##### Command Breakdown: + - `--copt=-DENABLE_LOGS_PREVIEW`: Enables preview logs. + - `--test_output=errors`: Shows only the errors in the test output. + - `--cache_test_results=no`: Forces Bazel to re-run tests without caching. + - `--copt=-DENABLE_TEST`: Enables testing capabilities for the target code. + - `//exporters/otlp/...`: Specifies the test target path. + +#### 2. Run CI Script + +You can also run the CI script provided to perform testing with the following command as an example: + +```bash +bash ci/do_ci.sh cmake.exporter.otprotocol.test +``` + +This command initiates the CI pipeline, executing tests specifically for the **cmake.exporter.otprotocol** module. + +#### Troubleshooting + +If you encounter issues: + +- **Rebuild the DevContainer**: From the command palette, run **Remote-Containers: Rebuild Container** to reinitialize the environment. +- **Check Bazelisk and CI Script Logs**: Inspect logs for any configuration or dependency issues. + +#### Additional Notes + +- You can adjust compiler options (`--copt`) as needed to test additional flags or enable/disable specific features. +- The test results will be displayed in the terminal within the DevContainer for easy debugging. + +#### Resources + +- **Bazelisk Documentation**: [https://github.com/bazelbuild/bazelisk](https://github.com/bazelbuild/bazelisk) +- **VSCode DevContainer Documentation**: [https://code.visualstudio.com/docs/remote/containers](https://code.visualstudio.com/docs/remote/containers) + ## Pull Requests ### How to Send Pull Requests From 06149eb8b9dc46428aca260752c949ba0e3ec9f5 Mon Sep 17 00:00:00 2001 From: Ehsan Saei <71217171+esigo@users.noreply.github.com> Date: Wed, 6 Nov 2024 21:58:22 +0100 Subject: [PATCH 5/9] fix CI --- CONTRIBUTING.md | 58 ++++++++++++++++++++++++++++++++----------------- 1 file changed, 38 insertions(+), 20 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3036a0fa61..3b725c4164 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -62,7 +62,10 @@ bazel-bin/examples/simple/example_simple ### DevContainer Setup for Project -This guide provides instructions on how to set up and use the development container (`devcontainer`) environment to streamline testing and development for this project. With the DevContainer, you can work in a consistent environment configured with all the necessary dependencies and tools. +This guide provides instructions on how to set up and use the development +container (`devcontainer`) environment to streamline testing and development +for this project. With the DevContainer, you can work in a consistent environment +configured with all the necessary dependencies and tools. #### Prerequisites @@ -73,17 +76,25 @@ Before getting started, ensure you have the following installed: #### Getting Started -1. **Open the Project in DevContainer**: - - Open the project in VSCode. - - When prompted to "Reopen in Container," select this option. If you’re not prompted, you can manually open the container by selecting **Remote-Containers: Reopen in Container** from the command palette (`F1` or `Ctrl+Shift+P`). +1. **Open the Project in DevContainer**: -2. **Container Setup**: The DevContainer environment will automatically build based on the configuration files provided (e.g., `.devcontainer/devcontainer.json`). This setup will install required dependencies, tools, and environment variables needed for the project. + Open the project in VSCode. When prompted to "Reopen in Container," select + this option. If you’re not prompted, you can manually open the container by + selecting **Remote-Containers: Reopen in Container** from the command palette + (`F1` or `Ctrl+Shift+P`). + +2. **Container Setup**: + + The DevContainer environment will automatically build based on the configuration + files provided (e.g., `.devcontainer/devcontainer.json`). This setup will install + required dependencies, tools, and environment variables needed for the project. #### Available Commands -Once inside the DevContainer, you can use the following commands to run tests and CI workflows. +Once inside the DevContainer, you can use the following commands to run tests +and CI workflows. -#### 1. Run Tests with Bazelisk +##### 1. Run Tests with Bazelisk To run tests with Bazelisk using specific compilation options, use: @@ -91,34 +102,41 @@ To run tests with Bazelisk using specific compilation options, use: bazelisk-linux-amd64 test --copt=-DENABLE_LOGS_PREVIEW --test_output=errors --cache_test_results=no --copt=-DENABLE_TEST //exporters/otlp/... ``` -##### Command Breakdown: - - `--copt=-DENABLE_LOGS_PREVIEW`: Enables preview logs. - - `--test_output=errors`: Shows only the errors in the test output. - - `--cache_test_results=no`: Forces Bazel to re-run tests without caching. - - `--copt=-DENABLE_TEST`: Enables testing capabilities for the target code. - - `//exporters/otlp/...`: Specifies the test target path. +###### Command Breakdown + +- `--copt=-DENABLE_LOGS_PREVIEW`: Enables preview logs. +- `--test_output=errors`: Shows only the errors in the test output. +- `--cache_test_results=no`: Forces Bazel to re-run tests without caching. +- `--copt=-DENABLE_TEST`: Enables testing capabilities for the target code. +- `//exporters/otlp/...`: Specifies the test target path. -#### 2. Run CI Script +##### 2. Run CI Script -You can also run the CI script provided to perform testing with the following command as an example: +You can also run the CI script provided to perform testing with the following command as an +example: ```bash bash ci/do_ci.sh cmake.exporter.otprotocol.test ``` -This command initiates the CI pipeline, executing tests specifically for the **cmake.exporter.otprotocol** module. +This command initiates the CI pipeline, executing tests specifically for the +**cmake.exporter.otprotocol** module. #### Troubleshooting If you encounter issues: -- **Rebuild the DevContainer**: From the command palette, run **Remote-Containers: Rebuild Container** to reinitialize the environment. -- **Check Bazelisk and CI Script Logs**: Inspect logs for any configuration or dependency issues. +- **Rebuild the DevContainer**: From the command palette, run + **Remote-Containers: Rebuild Container** to reinitialize the environment. +- **Check Bazelisk and CI Script Logs**: Inspect logs for any configuration or + dependency issues. #### Additional Notes -- You can adjust compiler options (`--copt`) as needed to test additional flags or enable/disable specific features. -- The test results will be displayed in the terminal within the DevContainer for easy debugging. +- You can adjust compiler options (`--copt`) as needed to test additional flags + or enable/disable specific features. +- The test results will be displayed in the terminal within the DevContainer for + easy debugging. #### Resources From 07e3a27323bb7db25be089a187aedc9ad2763ebc Mon Sep 17 00:00:00 2001 From: Ehsan Saei <71217171+esigo@users.noreply.github.com> Date: Wed, 6 Nov 2024 21:27:37 +0000 Subject: [PATCH 6/9] fix CI --- .devcontainer/Dockerfile.dev | 3 +- CONTRIBUTING.md | 72 ++++++++++++++++++------------------ 2 files changed, 39 insertions(+), 36 deletions(-) diff --git a/.devcontainer/Dockerfile.dev b/.devcontainer/Dockerfile.dev index 7e24cb8088..6eec367f88 100644 --- a/.devcontainer/Dockerfile.dev +++ b/.devcontainer/Dockerfile.dev @@ -14,7 +14,8 @@ COPY ci /opt/ci RUN apt update && apt install -y wget \ ninja-build \ - libcurl4-openssl-dev + libcurl4-openssl-dev \ + markdownlint RUN cd /opt/ci && bash setup_cmake.sh RUN cd /opt/ci && bash setup_ci_environment.sh diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3b725c4164..dcf9ceb8a6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -62,36 +62,36 @@ bazel-bin/examples/simple/example_simple ### DevContainer Setup for Project -This guide provides instructions on how to set up and use the development -container (`devcontainer`) environment to streamline testing and development -for this project. With the DevContainer, you can work in a consistent environment +This guide provides instructions on how to set up and use the development +container (`devcontainer`) environment to streamline testing and development +for this project. With the DevContainer, you can work in a consistent environment configured with all the necessary dependencies and tools. #### Prerequisites Before getting started, ensure you have the following installed: -1. **Docker**: DevContainers require Docker for containerization. -2. **Visual Studio Code (VSCode)** with the **Remote - Containers** extension. +* **Docker**: DevContainers require Docker for containerization. +* **Visual Studio Code (VSCode)** with the **Remote - Containers** extension. #### Getting Started -1. **Open the Project in DevContainer**: +* **Open the Project in DevContainer**: - Open the project in VSCode. When prompted to "Reopen in Container," select - this option. If you’re not prompted, you can manually open the container by - selecting **Remote-Containers: Reopen in Container** from the command palette + Open the project in VSCode. When prompted to "Reopen in Container," select + this option. If you’re not prompted, you can manually open the container by + selecting **Remote-Containers: Reopen in Container** from the command palette (`F1` or `Ctrl+Shift+P`). -2. **Container Setup**: +* **Container Setup**: - The DevContainer environment will automatically build based on the configuration - files provided (e.g., `.devcontainer/devcontainer.json`). This setup will install + The DevContainer environment will automatically build based on the configuration + files provided (e.g., `.devcontainer/devcontainer.json`). This setup will install required dependencies, tools, and environment variables needed for the project. #### Available Commands -Once inside the DevContainer, you can use the following commands to run tests +Once inside the DevContainer, you can use the following commands to run tests and CI workflows. ##### 1. Run Tests with Bazelisk @@ -99,49 +99,51 @@ and CI workflows. To run tests with Bazelisk using specific compilation options, use: ```bash -bazelisk-linux-amd64 test --copt=-DENABLE_LOGS_PREVIEW --test_output=errors --cache_test_results=no --copt=-DENABLE_TEST //exporters/otlp/... +bazelisk-linux-amd64 test --copt=-DENABLE_LOGS_PREVIEW +--test_output=errors --cache_test_results=no --copt=-DENABLE_TEST //exporters/otlp/... ``` ###### Command Breakdown -- `--copt=-DENABLE_LOGS_PREVIEW`: Enables preview logs. -- `--test_output=errors`: Shows only the errors in the test output. -- `--cache_test_results=no`: Forces Bazel to re-run tests without caching. -- `--copt=-DENABLE_TEST`: Enables testing capabilities for the target code. -- `//exporters/otlp/...`: Specifies the test target path. +* `--copt=-DENABLE_LOGS_PREVIEW`: Enables preview logs. +* `--test_output=errors`: Shows only the errors in the test output. +* `--cache_test_results=no`: Forces Bazel to re-run tests without caching. +* `--copt=-DENABLE_TEST`: Enables testing capabilities for the target code. +* `//exporters/otlp/...`: Specifies the test target path. ##### 2. Run CI Script -You can also run the CI script provided to perform testing with the following command as an +You can also run the CI script provided to perform testing with the +following command as an example: ```bash bash ci/do_ci.sh cmake.exporter.otprotocol.test ``` -This command initiates the CI pipeline, executing tests specifically for the +This command initiates the CI pipeline, executing tests specifically for the **cmake.exporter.otprotocol** module. #### Troubleshooting If you encounter issues: -- **Rebuild the DevContainer**: From the command palette, run +* **Rebuild the DevContainer**: From the command palette, run **Remote-Containers: Rebuild Container** to reinitialize the environment. -- **Check Bazelisk and CI Script Logs**: Inspect logs for any configuration or +* **Check Bazelisk and CI Script Logs**: Inspect logs for any configuration or dependency issues. #### Additional Notes -- You can adjust compiler options (`--copt`) as needed to test additional flags +* You can adjust compiler options (`--copt`) as needed to test additional flags or enable/disable specific features. -- The test results will be displayed in the terminal within the DevContainer for +* The test results will be displayed in the terminal within the DevContainer for easy debugging. #### Resources -- **Bazelisk Documentation**: [https://github.com/bazelbuild/bazelisk](https://github.com/bazelbuild/bazelisk) -- **VSCode DevContainer Documentation**: [https://code.visualstudio.com/docs/remote/containers](https://code.visualstudio.com/docs/remote/containers) +* **Bazelisk Documentation**: [https://github.com/bazelbuild/bazelisk](https://github.com/bazelbuild/bazelisk) +* **VSCode DevContainer Documentation**: [https://code.visualstudio.com/docs/remote/containers](https://code.visualstudio.com/docs/remote/containers) ## Pull Requests @@ -269,16 +271,16 @@ the C++ repository. * [OpenTelemetry Specification](https://github.com/open-telemetry/opentelemetry-specification) - * The OpenTelemetry Specification describes the requirements and expectations - of for all OpenTelemetry implementations. + * The OpenTelemetry Specification describes the requirements and expectations + of for all OpenTelemetry implementations. * Read through the OpenTelemetry C++ documentation - * The - [API](https://opentelemetry-cpp.readthedocs.io/en/latest/api/api.html) - and - [SDK](https://opentelemetry-cpp.readthedocs.io/en/latest/sdk/sdk.html) - documentation provides a lot of information on what the classes and their - functions are used for. + * The + [API](https://opentelemetry-cpp.readthedocs.io/en/latest/api/api.html) + and + [SDK](https://opentelemetry-cpp.readthedocs.io/en/latest/sdk/sdk.html) + documentation provides a lot of information on what the classes and their + functions are used for. Please contribute! You’re welcome to add more information if you come across any helpful resources. From 964d17491dea7d27b13edd2eefd7378946d028d4 Mon Sep 17 00:00:00 2001 From: Ehsan Saei <71217171+esigo@users.noreply.github.com> Date: Wed, 6 Nov 2024 22:30:37 +0100 Subject: [PATCH 7/9] revert unrelated changes --- CONTRIBUTING.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dcf9ceb8a6..bf837f6bd1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -271,16 +271,16 @@ the C++ repository. * [OpenTelemetry Specification](https://github.com/open-telemetry/opentelemetry-specification) - * The OpenTelemetry Specification describes the requirements and expectations - of for all OpenTelemetry implementations. + * The OpenTelemetry Specification describes the requirements and expectations + of for all OpenTelemetry implementations. * Read through the OpenTelemetry C++ documentation - * The - [API](https://opentelemetry-cpp.readthedocs.io/en/latest/api/api.html) - and - [SDK](https://opentelemetry-cpp.readthedocs.io/en/latest/sdk/sdk.html) - documentation provides a lot of information on what the classes and their - functions are used for. + * The + [API](https://opentelemetry-cpp.readthedocs.io/en/latest/api/api.html) + and + [SDK](https://opentelemetry-cpp.readthedocs.io/en/latest/sdk/sdk.html) + documentation provides a lot of information on what the classes and their + functions are used for. Please contribute! You’re welcome to add more information if you come across any helpful resources. From 1eaac267285f88841f23ef2cbf7c1f5040cae209 Mon Sep 17 00:00:00 2001 From: Ehsan Saei <71217171+esigo@users.noreply.github.com> Date: Wed, 6 Nov 2024 22:52:04 +0100 Subject: [PATCH 8/9] update CI run instructions --- ci/README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/ci/README.md b/ci/README.md index 65bea032d7..03a5002249 100644 --- a/ci/README.md +++ b/ci/README.md @@ -1,7 +1,9 @@ # Building and running tests as a developer -CI tests can be run on docker by invoking the script `./ci/run_docker.sh -./ci/do_ci.sh {TARGET}` where the targets are: +CI tests can be run inside +[devcontainer](../CONTRIBUTING.md###DevContainer-Setup-for-Project) +by invoking the script +`./ci/do_ci.sh {TARGET}` where the targets are: * `cmake.test`: build cmake targets and run tests. * `cmake.maintainer.test`: build with cmake and test, in maintainer mode. From 29b860aa123e1220ea6747c65324cc0440712ccb Mon Sep 17 00:00:00 2001 From: Ehsan Saei <71217171+esigo@users.noreply.github.com> Date: Wed, 6 Nov 2024 22:55:39 +0100 Subject: [PATCH 9/9] fix link --- ci/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ci/README.md b/ci/README.md index 03a5002249..ec1b093448 100644 --- a/ci/README.md +++ b/ci/README.md @@ -1,7 +1,7 @@ # Building and running tests as a developer CI tests can be run inside -[devcontainer](../CONTRIBUTING.md###DevContainer-Setup-for-Project) +[devcontainer](../CONTRIBUTING.md#devcontainer-setup-for-project) by invoking the script `./ci/do_ci.sh {TARGET}` where the targets are: