Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed CI build errors for example external project. #284

Merged
merged 3 commits into from
Nov 1, 2023
Merged

Fixed CI build errors for example external project. #284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
489cef5
Updated min cmake version to avoid cmake 3.5 deprecation warnings.
adamshapiro0 Nov 1, 2023
8e5aae1
Recommend usinging FetchContent via HTTPS over git.
adamshapiro0 Nov 1, 2023
4acbbaa
Update external project example to release 1.22.3.
adamshapiro0 Nov 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Copyright (C) Point One Navigation - All Rights Reserved
cmake_minimum_required(VERSION 3.3.2)
cmake_minimum_required(VERSION 3.12)

# Set toolchain parameters before calling project().
set(CMAKE_CXX_STANDARD 11)
Expand Down
20 changes: 12 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,12 @@ below, rather than compiling and installing the library manually as in the secti
include(FetchContent)
FetchContent_Declare(
fusion_engine_client
GIT_REPOSITORY https://github.com/PointOneNav/fusion-engine-client.git
GIT_TAG v1.15.2
# Recommended:
URL https://github.com/PointOneNav/fusion-engine-client/archive/refs/tags/v1.22.3.zip
URL_HASH MD5=cfe1de319725822a1b825cd3421fb6b1
# Alternatively:
# GIT_REPOSITORY https://github.com/PointOneNav/fusion-engine-client.git
# GIT_TAG v1.22.3
)
set(P1_FE_BUILD_EXAMPLES OFF CACHE INTERNAL "")
FetchContent_MakeAvailable(fusion_engine_client)
Expand All @@ -109,10 +113,10 @@ add_executable(example_app main.cc)
target_link_libraries(example_app PUBLIC fusion_engine_client)
```

Note that we strongly recommend using a specific version of the library in your code by specifying a git tag (e.g.,
`GIT_TAG v1.15.2`), and updating that as new versions are released. That way, you can be sure that your code is always
built with a known version of fusion-engine-client. If you prefer, however, you can tell CMake to track the latest
changes by using `GIT_TAG master` instead.
Note that we strongly recommend using a specific version of the library in your code by specifying a release zip file or
a git tag (e.g., `GIT_TAG vA.B.C`), and updating that as new versions are released. That way, you can be sure that your
code is always built with a known version of fusion-engine-client. If you prefer, however, you can tell CMake to track
the latest changes by using `GIT_TAG master` instead.

See [examples/external_cmake_project/CMakeLists.txt](examples/external_cmake_project/CMakeLists.txt) for more details.

Expand Down Expand Up @@ -164,12 +168,12 @@ To use this library in an existing Bazel project, add the following to your proj
git_repository(
name = "fusion_engine_client",
remote = "[email protected]:PointOneNav/fusion_engine_client.git",
tag = "v1.15.2",
tag = "v1.22.3",
)
```

Note that we strongly recommend using a specific version of the library in your code by specifying a git tag (e.g.,
`tag = "v1.15.2"`), and updating that as new versions are released. That way, you can be sure that your code is always
`tag = "v1.22.3"`), and updating that as new versions are released. That way, you can be sure that your code is always
built with a known version of fusion-engine-client. If you prefer, however, you can tell Bazel to track the latest
changes by using `branch = "master"` instead.

Expand Down
18 changes: 11 additions & 7 deletions examples/external_cmake_project/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ project(fusion_engine_usage_example C CXX)
# Use FetchContent to import the fusion-engine-client C++ library using Git.
#
# Note that we always recommend using a specific version of the library in your
# code by specifying a git tag (e.g., `GIT_TAG v1.15.2`), and updating that as
# new versions are released. That way, you can be sure that your code is always
# built with a known version of fusion-engine-client. If you prefer, however,
# you can set the GIT_TAG to track the latest changes by setting
# `GIT_TAG master` below.
# code by specifying a release zip file or a git tag (e.g., `GIT_TAG vA.B.C`),
# and updating that as new versions are released. That way, you can be sure that
# your code is always built with a known version of fusion-engine-client. If you
# prefer, however, you can set the GIT_TAG to track the latest changes by
# setting `GIT_TAG master` below.
#
# We explicitly disable example applications from the fusion-engine-client
# library by setting P1_FE_BUILD_EXAMPLES to OFF below. We only want to build
Expand All @@ -38,8 +38,12 @@ project(fusion_engine_usage_example C CXX)
include(FetchContent)
FetchContent_Declare(
fusion_engine_client
GIT_REPOSITORY https://github.com/PointOneNav/fusion-engine-client.git
GIT_TAG v1.16.0
# Recommended:
URL https://github.com/PointOneNav/fusion-engine-client/archive/refs/tags/v1.22.3.zip
URL_HASH MD5=cfe1de319725822a1b825cd3421fb6b1
# Or alternatively:
# GIT_REPOSITORY https://github.com/PointOneNav/fusion-engine-client.git
# GIT_TAG v1.22.3
)
set(P1_FE_BUILD_EXAMPLES OFF CACHE INTERNAL "")
FetchContent_MakeAvailable(fusion_engine_client)
Expand Down
Loading