Skip to content

Commit

Permalink
Merge branch 'main' into emilk/albedo-factor
Browse files Browse the repository at this point in the history
  • Loading branch information
emilk committed Jul 10, 2024
2 parents 56e118c + b277376 commit dd2d83d
Show file tree
Hide file tree
Showing 13 changed files with 375 additions and 299 deletions.
12 changes: 6 additions & 6 deletions .github/workflows/contrib_checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -167,12 +167,12 @@ jobs:
# 😭
# - name: Build and run C++ tests with clang++
# run: |
# pixi run cpp-clean
# RERUN_WERROR=ON RERUN_USE_ASAN=ON CXX=clang++ pixi run cpp-build-all
# RERUN_WERROR=ON RERUN_USE_ASAN=ON CXX=clang++ pixi run cpp-test
# pixi run -e cpp cpp-clean
# RERUN_WERROR=ON RERUN_USE_ASAN=ON CXX=clang++ pixi run -e cpp cpp-build-all
# RERUN_WERROR=ON RERUN_USE_ASAN=ON CXX=clang++ pixi run -e cpp cpp-test

- name: Build and run C++ tests with g++
run: |
pixi run cpp-clean
RERUN_WERROR=ON RERUN_USE_ASAN=ON CXX=g++ pixi run cpp-build-all
RERUN_WERROR=ON RERUN_USE_ASAN=ON CXX=g++ pixi run cpp-test
pixi run -e cpp cpp-clean
RERUN_WERROR=ON RERUN_USE_ASAN=ON CXX=g++ pixi run -e cpp cpp-build-all
RERUN_WERROR=ON RERUN_USE_ASAN=ON CXX=g++ pixi run -e cpp cpp-test
2 changes: 1 addition & 1 deletion .github/workflows/cpp_matrix_full.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"runs_on": "ubuntu-latest-16-cores",
"cache_key": "build-linux",
"extra_env_vars": "RERUN_USE_ASAN=1 RERUN_SET_CXX_VERSION=17",
"additional_commands": "pixi run cpp-docs"
"additional_commands": "pixi run -e cpp cpp-docs"
},
{
"name": "Linux x64, C++20",
Expand Down
16 changes: 8 additions & 8 deletions .github/workflows/reusable_checks_cpp.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,18 +88,18 @@ jobs:
# using leading to random crashes: https://reviews.llvm.org/D148280
run: sudo sysctl vm.mmap_rnd_bits=28

- name: pixi run cpp-clean
run: pixi run cpp-clean
- name: pixi run -e cpp cpp-clean
run: pixi run -e cpp cpp-clean

- name: pixi run cpp-build-all
run: ${{ matrix.extra_env_vars }} RERUN_WERROR=ON pixi run cpp-build-all
- name: pixi run -e cpp cpp-build-all
run: ${{ matrix.extra_env_vars }} RERUN_WERROR=ON pixi run -e cpp cpp-build-all

- name: pixi run cpp-test
run: ${{ matrix.extra_env_vars }} RERUN_WERROR=ON pixi run cpp-test
- name: pixi run -e cpp cpp-test
run: ${{ matrix.extra_env_vars }} RERUN_WERROR=ON pixi run -e cpp cpp-test

- name: pixi run cpp-build-all-shared-libs
- name: pixi run -e cpp cpp-build-all-shared-libs
if: ${{ inputs.CHANNEL == 'nightly' }}
run: ${{ matrix.extra_env_vars }} RERUN_WERROR=ON pixi run cpp-build-all-shared-libs
run: ${{ matrix.extra_env_vars }} RERUN_WERROR=ON pixi run -e cpp cpp-build-all-shared-libs

- name: additional_commands
run: ${{ matrix.additional_commands }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/reusable_deploy_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ jobs:
pixi-version: v0.25.0

- name: Doxygen C++ docs
run: pixi run cpp-docs
run: pixi run -e cpp cpp-docs

- name: Set up git author
run: |
Expand Down
6 changes: 3 additions & 3 deletions BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,18 +91,18 @@ On Windows you have to have a system install of Visual Studio 2022 in order to c

All other dependencies are downloaded by Pixi! You can run tests with:
```sh
pixi run cpp-test
pixi run -e cpp cpp-test
```
and build all C++ artifacts with:
```sh
pixi run cpp-build-all
pixi run -e cpp cpp-build-all
```

## Building the docs

High-level documentation for Rerun can be found at [http://rerun.io/docs](http://rerun.io/docs). It is built from the separate repository [rerun-docs](https://github.com/rerun-io/rerun-docs).

- 🌊 [C++ API docs](https://ref.rerun.io/docs/cpp) are built with `doxygen` and hosted on GitHub. Use `pixi run cpp-docs` to build them locally. For details on the C++ doc-system, see [Writing Docs](rerun_cpp/docs/writing_docs.md).
- 🌊 [C++ API docs](https://ref.rerun.io/docs/cpp) are built with `doxygen` and hosted on GitHub. Use `pixi run -e cpp cpp-docs` to build them locally. For details on the C++ doc-system, see [Writing Docs](rerun_cpp/docs/writing_docs.md).
- 🐍 [Python API docs](https://ref.rerun.io/docs/python) are built via `mkdocs` and hosted on GitHub. For details on the Python doc-system, see [Writing Docs](rerun_py/docs/writing_docs.md).
- 🦀 [Rust API docs](https://docs.rs/rerun/) are hosted on <https://docs.rs/rerun/>. You can build them locally with: `cargo doc --all-features --no-deps --open`.

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ TODO(andreas): This doesn't list tasks from all Pixi environments. There's no wa
We use [cargo deny](https://github.com/EmbarkStudios/cargo-deny) to check our dependency tree for copy-left licenses, duplicate dependencies and [rustsec advisories](https://rustsec.org/advisories). You can configure it in `deny.toml`. Usage: `cargo deny check`
Configure your editor to run `cargo fmt` on save. Also configure it to strip trailing whitespace, and to end each file with a newline. Settings for VSCode can be found in the `.vscode` folder and should be applied automatically. If you are using another editor, consider adding good setting to this repository!

Depending on the changes you made run `cargo test --all-targets --all-features`, `pixi run py-test` and `pixi run cpp-test` locally.
Depending on the changes you made run `cargo test --all-targets --all-features`, `pixi run py-test` and `pixi run -e cpp cpp-test` locally.

### Linting
Prior to pushing changes to a PR, at a minimum, you should always run `pixi run fast-lint`. This is designed to run
Expand Down
2 changes: 1 addition & 1 deletion docs/snippets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Most of these examples are automatically used as docstrings for the `Archetype`
You can run each example individually using the following:

- **C++**:
- `pixi run cpp-build-snippets` to compile all examples
- `pixi run -e cpp cpp-build-snippets` to compile all examples
- `./build/docs/snippets/all/<example_name>` to run, e.g. `./build/docs/snippets/all/point3d_random`
- **Python**: `python <example_name>.py`, e.g. `python point3d_random.py`.
- **Rust**: `cargo run -p snippets -- <example_name> [args]`, e.g. `cargo run -p snippets -- point3d_random`.
Expand Down
2 changes: 1 addition & 1 deletion examples/cpp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ using the accompanying [`C++ Quick Start`](https://www.rerun.io/docs/getting-sta
## Build all examples
The CMake target `examples` is a convenient alias for building all CMake examples in one go.

You can use `pixi run cpp-build-examples` to invoke it within the repository's Pixi environment.
You can use `pixi run -e cpp cpp-build-examples` to invoke it within the repository's Pixi environment.
After that, you can run individual examples from `./build/examples/cpp/` (e.g. `./build/examples/cpp/dna/example_dna`).

## Contributions welcome
Expand Down
Loading

0 comments on commit dd2d83d

Please sign in to comment.