Merge branch 'gz-common5' into bazel

gazebosim · Apr 10, 2024 · 46dc856 · 46dc856
2 parents 6517106 + cd159c2
commit 46dc856
Show file tree

Hide file tree

Showing 47 changed files with 9,466 additions and 105 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,14 +1,20 @@
 name: Ubuntu CI
 
-on: [push, pull_request]
+on:
+  pull_request:
+  push:
+    branches:
+      - 'ign-common[0-9]'
+      - 'gz-common[0-9]'
+      - 'main'
 
 jobs:
   focal-ci:
     runs-on: ubuntu-latest
     name: Ubuntu Focal CI
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Compile and test
         id: ci
         uses: gazebo-tooling/action-gz-ci@focal

diff --git a/.github/workflows/macos.yml b/.github/workflows/macos.yml
@@ -14,6 +14,15 @@ jobs:
       uses: Homebrew/actions/setup-homebrew@master
     - run: brew config
 
+    # Workaround for https://github.com/actions/setup-python/issues/577
+    - name: Clean up python binaries
+      run: |
+        rm -f /usr/local/bin/2to3*;
+        rm -f /usr/local/bin/idle3*;
+        rm -f /usr/local/bin/pydoc3*;
+        rm -f /usr/local/bin/python3*;
+        rm -f /usr/local/bin/python3*-config;
+
     - name: Install base dependencies
       run: |
         brew tap osrf/simulation;
@@ -39,12 +48,14 @@ jobs:
       run: cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local/Cellar/${PACKAGE}/HEAD
     - run: make
       working-directory: build
-    - run: make test
-      working-directory: build
-      env:
-        CTEST_OUTPUT_ON_FAILURE: 1
+    # Run make install before make test so that the package will be available to
+    # build examples as part of the test
     - name: make install
       working-directory: build
       run: |
         make install;
         brew link ${PACKAGE};
+    - run: make test
+      working-directory: build
+      env:
+        CTEST_OUTPUT_ON_FAILURE: 1
diff --git a/.github/workflows/triage.yml b/.github/workflows/triage.yml
@@ -10,10 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Add ticket to inbox
-        uses: technote-space/create-project-card-action@v1
+        uses: actions/[email protected]
         with:
-          PROJECT: Core development
-          COLUMN: Inbox
-          GITHUB_TOKEN: ${{ secrets.TRIAGE_TOKEN }}
-          CHECK_ORG_PROJECT: true
-
+          project-url: https://github.com/orgs/gazebosim/projects/7
+          github-token: ${{ secrets.TRIAGE_TOKEN }}
diff --git a/BUILD.bazel b/BUILD.bazel
@@ -7,13 +7,24 @@ load(
     "gz_export_header",
     "gz_include_header",
 )
+load(
+    "@gz//bazel/lint:lint.bzl",
+    "add_lint_tests",
+)
+load("@rules_license//rules:license.bzl", "license")
 
 package(
+    default_applicable_licenses = [GZ_ROOT + "common:license"],
     default_visibility = GZ_VISIBILITY,
     features = GZ_FEATURES,
 )
 
-licenses(["notice"])  # Apache-2.0
+license(
+    name = "license",
+    package_name = "gz-common",
+)
+
+licenses(["notice"])
 
 exports_files(["LICENSE"])
 
@@ -67,6 +78,10 @@ cc_library(
     name = "common",
     srcs = sources + private_headers,
     hdrs = public_headers,
+    copts = [
+        "-fexceptions",
+        "-Wno-unused-value",
+    ],
     includes = ["include"],
     deps = [
         GZ_ROOT + "utils",
@@ -86,10 +101,13 @@ test_sources = glob(
 [cc_test(
     name = src.replace("/", "_").replace(".cc", "").replace("src_", ""),
     srcs = [src],
+    copts = ["-fexceptions"],
     deps = [
         ":common",
         GZ_ROOT + "common/testing",
         "@gtest",
         "@gtest//:gtest_main",
     ],
 ) for src in test_sources]
+
+add_lint_tests()
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -3,7 +3,7 @@ cmake_minimum_required(VERSION 3.10.2 FATAL_ERROR)
 #============================================================================
 # Initialize the project
 #============================================================================
-project(gz-common5 VERSION 5.4.0)
+project(gz-common5 VERSION 5.5.1)
 set(GZ_COMMON_VER ${PROJECT_VERSION_MAJOR})
 
 #============================================================================
@@ -99,6 +99,7 @@ gz_find_package(
 # Find GDAL
 gz_find_package(GDAL VERSION 3.0
   PKGCONFIG gdal
+  PKGCONFIG_VER_COMPARISON >=
   PRIVATE_FOR geospatial
   REQUIRED_BY geospatial)
 
@@ -137,14 +138,13 @@ configure_file("${PROJECT_SOURCE_DIR}/cppcheck.suppress.in"
                ${PROJECT_BINARY_DIR}/cppcheck.suppress)
 
 gz_configure_build(QUIT_IF_BUILD_ERRORS
-  COMPONENTS av events geospatial graphics io profiler testing)
+  COMPONENTS av events graphics geospatial io profiler testing)
 
 #============================================================================
 # Create package information
 #============================================================================
 gz_create_packages()
 
-
 #============================================================================
 # Create documentation
 #============================================================================
@@ -157,3 +157,13 @@ gz_create_docs(
   TAGFILES
     "${GZ-MATH_DOXYGEN_TAGFILE} = ${GZ-MATH_API_URL}"
   )
+
+#============================================================================
+# Build examples
+#============================================================================
+if (BUILD_TESTING)
+  gz_build_examples(
+    SOURCE_DIR ${PROJECT_SOURCE_DIR}/examples
+    BINARY_DIR ${PROJECT_BINARY_DIR}/examples
+  )
+endif()
diff --git a/Changelog.md b/Changelog.md
@@ -1,5 +1,116 @@
 ## Gazebo Common 5.x
 
+## Gazebo Common 5.5.1 (2024-03-14)
+
+1. Various Bazel adjustments for linting
+    * [Pull request #582](https://github.com/gazebosim/gz-common/pull/582)
+
+1. Extend AssimpLoader to parse material transmission factor
+    * [Pull request #577](https://github.com/gazebosim/gz-common/pull/577)
+
+1. Fix noise issue that appears in certain image textures
+    * [Pull request #578](https://github.com/gazebosim/gz-common/pull/578)
+
+## Gazebo Common 5.5.0 (2024-02-26)
+
+1. Be louder when graphics is missing for geospatial
+    * [Pull request #573](https://github.com/gazebosim/gz-common/pull/573)
+
+1. Multiple memory cleanup fixes
+    * [Pull request #571](https://github.com/gazebosim/gz-common/pull/571)
+
+1. Clarify GDAL version requirement
+    * [Pull request #574](https://github.com/gazebosim/gz-common/pull/574)
+
+1. 🎈  3.17.0
+    * [Pull request #567](https://github.com/gazebosim/gz-common/pull/567)
+
+1. Update CI badges in README
+    * [Pull request #566](https://github.com/gazebosim/gz-common/pull/566)
+
+1. Backwards compatible assimp texture name fix
+    * [Pull request #565](https://github.com/gazebosim/gz-common/pull/565)
+
+1. Fix error output when creating directories
+    * [Pull request #561](https://github.com/gazebosim/gz-common/pull/561)
+
+1. Update github action workflows
+    * [Pull request #558](https://github.com/gazebosim/gz-common/pull/558)
+
+1. Fix segfault in case of no write access to log dir
+    * [Pull request #546](https://github.com/gazebosim/gz-common/pull/546)
+
+1. ign -> gz
+    * [Pull request #547](https://github.com/gazebosim/gz-common/pull/547)
+
+1. Support loading glb with compressed jpeg textures
+    * [Pull request #545](https://github.com/gazebosim/gz-common/pull/545)
+
+1. Fix glTF / glb root node transform
+    * [Pull request #543](https://github.com/gazebosim/gz-common/pull/543)
+
+1. EnumIface: suppress deprecation warning
+    * [Pull request #540](https://github.com/gazebosim/gz-common/pull/540)
+
+1. Prevent loading lightmaps if mesh is a glb file that has an occlusion-metallic-roughness texture
+    * [Pull request #538](https://github.com/gazebosim/gz-common/pull/538)
+
+1. 🎈 3.16.0
+    * [Pull request #519](https://github.com/gazebosim/gz-common/pull/519)
+
+1. Fix cstdint with GCC 13
+    * [Pull request #528](https://github.com/gazebosim/gz-common/pull/528)
+    * [Pull request #517](https://github.com/gazebosim/gz-common/pull/517)
+    * [Pull request #513](https://github.com/gazebosim/gz-common/pull/513)
+
+## Gazebo Common 5.4.2 (2023-09-26)
+
+1. Documentation fixes
+    * [Pull request #534](https://github.com/gazebosim/gz-common/pull/534)
+    * [Pull request #535](https://github.com/gazebosim/gz-common/pull/535)
+
+1. Fix glTF metalness and roughness map orientation
+    * [Pull request #532](https://github.com/gazebosim/gz-common/pull/532)
+
+1. Build examples from CMake rather than executable
+    * [Pull request #502](https://github.com/gazebosim/gz-common/pull/502)
+
+
+## Gazebo Common 5.4.1 (2023-08-21)
+
+1. Use `pull_request_target`  for triage workflow
+    * [Pull request #527](https://github.com/gazebosim/gz-common/pull/527)
+
+1. Fix Github project automation for new project board
+    * [Pull request #526](https://github.com/gazebosim/gz-common/pull/526)
+
+1. Fix Github Actions on macOS
+    * [Pull request #524](https://github.com/gazebosim/gz-common/pull/524)
+
+1. Only build integration tests if libraries exist
+    * [Pull request #523](https://github.com/gazebosim/gz-common/pull/523)
+
+1. Fix compiling under linux
+    * [Pull request #521](https://github.com/gazebosim/gz-common/pull/521)
+
+1. Add missing <fstream> header includes
+    * [Pull request #518](https://github.com/gazebosim/gz-common/pull/518)
+
+1. Header was dropped in the forward port and breaks downstream
+    * [Pull request #515](https://github.com/gazebosim/gz-common/pull/515)
+
+1. Port: 4 to 5
+    * [Pull request #511](https://github.com/gazebosim/gz-common/pull/511)
+
+1. Lint
+    * [Pull request #Lint](https://github.com/gazebosim/gz-common/pull/Lint)
+
+1. 🎈 4.7.0
+    * [Pull request #510](https://github.com/gazebosim/gz-common/pull/510)
+
+1. Fix build error when using gz:: with ign-common4
+    * [Pull request #489](https://github.com/gazebosim/gz-common/pull/489)
+
 ## Gazebo Common 5.4.0 (2023-04-28)
 
 1. Add support for bayer images to be saved in a directory
@@ -621,6 +732,52 @@
 
 ## Gazebo Common 3.x
 
+## Gazebo Common 3.17.0 (2024-01-05)
+
+1. Fix error output when creating directories
+    * [Pull request #561](https://github.com/gazebosim/gz-common/pull/561)
+
+1. Update github action workflows
+    * [Pull request #558](https://github.com/gazebosim/gz-common/pull/558)
+
+1. Fix segfault in case of no write access to log dir
+    * [Pull request #546](https://github.com/gazebosim/gz-common/pull/546)
+
+## Gazebo Common 3.16.0 (2023-06-05)
+
+1. Include cstdint to build with GCC 13
+    * [Pull request #517](https://github.com/gazebosim/gz-common/pull/517)
+
+1. Fix missing cstdint header in latest gcc build
+    * [Pull request #513](https://github.com/gazebosim/gz-common/pull/513)
+
+1. Fix for ffmpeg v6
+    * [Pull request #497](https://github.com/gazebosim/gz-common/pull/497)
+
+1. Include cstring for memcpy
+    * [Pull request #501](https://github.com/gazebosim/gz-common/pull/501)
+
+1. Fixed MeshManager Singleton
+    * [Pull request #451](https://github.com/gazebosim/gz-common/pull/451)
+
+1. Rename COPYING to LICENSE
+    * [Pull request #494](https://github.com/gazebosim/gz-common/pull/494)
+
+1. Add marcoag as codeowner
+    * [Pull request #493](https://github.com/gazebosim/gz-common/pull/493)
+
+1. CI workflow: use checkout v3
+    * [Pull request #490](https://github.com/gazebosim/gz-common/pull/490)
+
+1. Improved coverage remotery
+    * [Pull request #467](https://github.com/gazebosim/gz-common/pull/467)
+
+1. Added BVH and STL loader tests
+    * [Pull request #466](https://github.com/gazebosim/gz-common/pull/466)
+
+1. Increased Image coverage
+    * [Pull request #465](https://github.com/gazebosim/gz-common/pull/465)
+
 ## Gazebo Common 3.15.1 (2022-10-11)
 
 1. Fix build on case-insensitive filesystems

diff --git a/README.md b/README.md
@@ -9,10 +9,10 @@
 
 Build | Status
 -- | --
-Test coverage | [![codecov](https://codecov.io/gh/gazebosim/gz-common/branch/main/graph/badge.svg)](https://codecov.io/gh/gazebosim/gz-common)
-Ubuntu Focal | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_common-ci-main-focal-amd64)](https://build.osrfoundation.org/job/ignition_common-ci-main-focal-amd64)
-Homebrew      | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_common-ci-main-homebrew-amd64)](https://build.osrfoundation.org/job/ignition_common-ci-main-homebrew-amd64)
-Windows       | [![Build Status](https://build.osrfoundation.org/job/ign_common-ci-win/badge/icon)](https://build.osrfoundation.org/job/ign_common-ci-win/)
+Test coverage | [![codecov](https://codecov.io/gh/gazebosim/gz-common/tree/gz-common5/graph/badge.svg)](https://codecov.io/gh/gazebosim/gz-common/tree/gz-common5)
+Ubuntu Jammy  | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_common-ci-gz-common5-jammy-amd64)](https://build.osrfoundation.org/job/gz_common-ci-gz-common5-jammy-amd64)
+Homebrew      | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_common-ci-gz-common5-homebrew-amd64)](https://build.osrfoundation.org/job/gz_common-ci-gz-common5-homebrew-amd64)
+Windows       | [![Build Status](https://build.osrfoundation.org/job/gz_common-5-win/badge/icon)](https://build.osrfoundation.org/job/gz_common-5-win/)
 
 Gazebo Common, a component of [Gazebo](https://gazebosim.org), provides a set of libraries that
 cover many different use cases. An audio-visual library supports
@@ -55,7 +55,7 @@ callback system.
 
 # Install
 
-See the [installation tutorial](https://gazebosim.org/api/common/4.0/install.html).
+See the [installation tutorial](https://gazebosim.org/api/common/5/install.html).
 
 # Usage
 
@@ -69,8 +69,10 @@ Refer to the following table for information about important directories and fil
 +-- av                       Header and source files for the AV component.
 +-- events                   Header and source files for the Event component.
 +-- examples                 Example programs.
++-- geospatial               Geospatial component for heightmap & DEMs
 +-- graphics                 Header and source files for the Graphics component.
-+-- include/gz/common  Header files for the core component.
++-- include/gz/common        Header files for the core component.
++-- io                       IO component. Read object from stream.
 +-- profiler                 Header and source files for the Profiler component.
 +-- src                      Core source files and unit tests.
 +-- test