[19452] Switch master to 3.0.x

.github/pull_request_template.md

@@ -19,7 +19,7 @@
     In case of bug fixes, please provide the list of supported branches where this fix should be also merged.
     Please uncomment following line, adjusting the corresponding target branches for the backport.
 -->
-<!-- @Mergifyio backport 2.13.x 2.10.x 2.6.x -->
+<!-- @Mergifyio backport 2.14.x 2.13.x 2.10.x 2.6.x -->
 
 <!-- If an issue is already opened, please uncomment next line with the corresponding issue number. -->
 <!-- Fixes #(issue) -->
@@ -35,6 +35,11 @@ Related implementation PR:
 
 ## Contributor Checklist
 
+<!--
+    - If any of the elements of the following checklist is not applicable, substitute the checkbox [ ] by _N/A_:
+    - If any of the elements of the following checklist is not fulfilled on purpose, please provide a reason and substitute the checkbox [ ] with ❌: or __NO__:.
+-->
+
 - [ ] Commit messages follow the project guidelines. <!-- External contributors should sign the DCO. Fast DDS docs developers must also refer to the internal Redmine task. -->
 - [ ] Code snippets related to the added documentation have been provided.
 - [ ] Documentation tests pass locally.

.github/workflows/mirror.yml

@@ -3,16 +3,19 @@ on:
   push:
     branches:
       - 'master'
+      - '2.14.x'
 
 jobs:
-  mirror_job:
+  mirror_job_master:
+    if: github.ref == 'refs/heads/master'
     name: Mirror master branch to latest minor branches
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
         dest_branch:
-          - '2.14.x'
+          - '3.0.x'
+          - '3.x'
     steps:
     - name: Mirror action step
       id: mirror
@@ -21,3 +24,21 @@ jobs:
         github-token: ${{ secrets.GITHUB_TOKEN }}
         source: 'master'
         dest: ${{ matrix.dest_branch }}
+
+  mirror_job_2_x:
+    if: github.ref == 'refs/heads/2.14.x'
+    name: Mirror 2.14.x branch to latest minor branches
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        dest_branch:
+          - '2.x'
+    steps:
+    - name: Mirror action step
+      id: mirror
+      uses: eProsima/eProsima-CI/external/mirror-branch-action@main
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        source: '2.14.x'
+        dest: ${{ matrix.dest_branch }}

CMakeLists.txt

@@ -29,6 +29,11 @@ string(REGEX REPLACE "^version = u'([0-9]+.[0-9]+.[0-9]+)'"
 
 project(fastdds-docs VERSION "${LIB_VERSION_STR}" LANGUAGES C CXX)
 
+# In case CMake version less than 3.24, add the option CMAKE_COMPILE_WARNING_AS_ERROR.
+if (${CMAKE_VERSION} VERSION_LESS "3.24")
+    option(CMAKE_COMPILE_WARNING_AS_ERROR "Treat warnings as errors" OFF)
+endif()
+
 
 ####################################################################################################
 # Build Doxygen documentation
@@ -38,8 +43,8 @@ project(fastdds-docs VERSION "${LIB_VERSION_STR}" LANGUAGES C CXX)
 #    * Generating the doxygen XML files that are then used for the API reference
 #    * Documentation tests applications
 # It is required that Fast DDS is built with -DSECURITY=ON
-find_package(fastrtps REQUIRED)
-get_target_property(FAST_INCLUDE_DIR fastrtps INTERFACE_INCLUDE_DIRECTORIES)
+find_package(fastdds REQUIRED)
+get_target_property(FAST_INCLUDE_DIR fastdds INTERFACE_INCLUDE_DIRECTORIES)
 
 message(STATUS "Fast DDS include directories: ${FAST_INCLUDE_DIR}")
 file(GLOB_RECURSE HPP_FILES "${FAST_INCLUDE_DIR}/fastdds/**/*.h*")
@@ -125,7 +130,9 @@ if (BUILD_DOCUMENTATION)
     # Generate the sphinx documentation
     add_custom_target(Sphinx ALL
         COMMAND
-        ${SPHINX_EXECUTABLE} -b ${FASTDDS_DOCS_BUILDER}
+        ${SPHINX_EXECUTABLE}
+        $<$<BOOL:${CMAKE_COMPILE_WARNING_AS_ERROR}>:-W>
+        -b ${FASTDDS_DOCS_BUILDER}
         # Tell Breathe where to find the Doxygen output
         -D breathe_projects.FastDDS=${DOXYGEN_OUTPUT_DIR}/xml
         ${PYTHON_EXTRA_FLAG}

README.md

@@ -4,6 +4,11 @@
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Linux Build Status](http://jenkins.eprosima.com:8080/job/nightly_fastdds-docs_master/badge/icon?subject=CI%20testing%20)](http://jenkins.eprosima.com:8080/job/nightly_fastdds-docs_master/)
 
+<!-- TODO(eduponz): Remove this before releasing v3.0.0 -->
+> [!WARNING]
+> **In preparation for v3.0.0, Fast DDS' master branch is undergoing major changes entailing API breaks.**
+> **Until Fast DDS v3.0.0 is released, it is strongly advisable to use the latest stable branch, [2.14.x](https://github.com/eProsima/Fast-DDS/tree/2.14.x).**
+
 <a href="http://www.eprosima.com"><img src="https://encrypted-tbn3.gstatic.com/images?q=tbn:ANd9GcSd0PDlVz1U_7MgdTe0FRIWD0Jc9_YH-gGi0ZpLkr-qgCI6ZEoJZ5GBqQ" align="left" hspace="8" vspace="2" width="100" height="100" ></a>
 
 *eprosima Fast DDS* (formerly Fast RTPS) is a C++ implementation of the DDS (Data Distribution Service) standard of the OMG (Object Management Group). eProsima Fast DDS implements the RTPS (Real Time Publish Subscribe) protocol, which provides publisher-subscriber communications over unreliable transports such as UDP,
@@ -114,8 +119,8 @@ building tools.
     mkdir -p <path_to_ws>/fastdds-docs_ws/src
     cd <path_to_ws>/fastdds-docs_ws
     wget https://raw.githubusercontent.com/eProsima/Fast-DDS-docs/<version>/colcon.meta
-    wget https://raw.githubusercontent.com/eProsima/Fast-DDS/<version>/fastrtps.repos
-    vcs import src < fastrtps.repos
+    wget https://raw.githubusercontent.com/eProsima/Fast-DDS/<version>/fastdds.repos
+    vcs import src < fastdds.repos
     cd src
     git clone https://github.com/eProsima/Fast-DDS-docs fastdds-docs
     ```

code/CMakeLists.txt

@@ -56,12 +56,12 @@ add_subdirectory(Examples/C++/DDSHelloWorld)
 # CodeTester utilizes Fast RTPS API
 add_executable(doctest CodeTester.cpp)
 target_include_directories(doctest PRIVATE ${FAST_INCLUDE_DIR})
-target_link_libraries(doctest fastrtps)
+target_link_libraries(doctest fastdds)
 
 # DDSCodeTester utilizes Fast DDS API
 add_executable(dds-doctest DDSCodeTester.cpp FastDDSGenCodeTester.cpp)
 target_include_directories(dds-doctest PRIVATE ${FAST_INCLUDE_DIR})
-target_link_libraries(dds-doctest fastrtps fastcdr)
+target_link_libraries(dds-doctest fastdds fastcdr)
 
 ####################################################################################################
 # Add tests
@@ -101,11 +101,11 @@ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/helloworld_test.py
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/grep.py
     ${CMAKE_CURRENT_BINARY_DIR}/grep.py COPYONLY)
 
-configure_file(${FAST_INCLUDE_DIR}/../share/fastRTPS_profiles.xsd
-    ${CMAKE_CURRENT_BINARY_DIR}/fastRTPS_profiles.xsd COPYONLY)
+configure_file(${FAST_INCLUDE_DIR}/../share/fastdds_profiles.xsd
+    ${CMAKE_CURRENT_BINARY_DIR}/fastdds_profiles.xsd COPYONLY)
 
 # Check validity of Permissions and Governance XML files using Fast RTPS API
-add_test(NAME xml.fastrtps_permissions_test
+add_test(NAME xml.rtps_permissions_test
     COMMAND doctest
     "file://${CMAKE_CURRENT_BINARY_DIR}/certs/maincacert.pem"
     "file://${CMAKE_CURRENT_BINARY_DIR}/certs/appcert.pem"
@@ -118,9 +118,9 @@ add_test(NAME xml.profiles COMMAND dds-doctest XMLTester.xml)
 # Check validity of XML full example
 add_test(NAME xml.example COMMAND dds-doctest XMLTesterExample.xml)
 # Validate XML full example against XSD schema
-add_test(NAME xml.validate COMMAND fastdds xml validate XMLTesterExample.xml -x fastRTPS_profiles.xsd)
+add_test(NAME xml.validate COMMAND fastdds xml validate XMLTesterExample.xml -x fastdds_profiles.xsd)
 # Validate XML snippets doc against XSD schema
-add_test(NAME xml.snippets COMMAND fastdds xml validate XMLTester.xml -x fastRTPS_profiles.xsd)
+add_test(NAME xml.snippets COMMAND fastdds xml validate XMLTester.xml -x fastdds_profiles.xsd)
 # Check validity of Permissions and Governance XML files using Fast DDS API
 add_test(NAME xml.fastdds_permissions_test
     COMMAND dds-doctest