From 2f781a0508c3c22c1381a1d31fa659f2bb77709d Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Mon, 22 Jul 2024 12:11:20 +0200 Subject: [PATCH] Improve CI workflows in 2.5.x, and branching model refactor (#365) (#368) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Refs #21226: Improve CI workflows in master and apply Fast DDS branching model Signed-off-by: JesusPoderoso * Refs #21226: Add RELEASE_SUPPORT.md file Signed-off-by: JesusPoderoso * Refs #21226: Add suggested changes from previous / similar PRs Signed-off-by: JesusPoderoso * Refs #21226: Apply rev suggestion Signed-off-by: JesusPoderoso --------- Signed-off-by: JesusPoderoso (cherry picked from commit d912d11bc7f1cbf9e89cc47b7053e701ec279e3c) Co-authored-by: Jesús Poderoso <120394830+JesusPoderoso@users.noreply.github.com> --- .github/workflows/ci.yaml | 55 ------ .github/workflows/config/build.meta | 7 + .github/workflows/config/test.repos | 5 + .github/workflows/reusable-ubuntu-ci.yml | 214 +++++++++++++++++++++++ .github/workflows/ubuntu-ci.yml | 70 ++++++++ RELEASE_SUPPORT.md | 6 + 6 files changed, 302 insertions(+), 55 deletions(-) delete mode 100644 .github/workflows/ci.yaml create mode 100644 .github/workflows/config/build.meta create mode 100644 .github/workflows/config/test.repos create mode 100644 .github/workflows/reusable-ubuntu-ci.yml create mode 100644 .github/workflows/ubuntu-ci.yml create mode 100644 RELEASE_SUPPORT.md diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml deleted file mode 100644 index 29be05c0..00000000 --- a/.github/workflows/ci.yaml +++ /dev/null @@ -1,55 +0,0 @@ -name: Continuous Integration - -on: - workflow_dispatch: - - push: - branches: - - 'master' - - pull_request: - branches: - - 'master' - -jobs: - ubuntu-build-test: - runs-on: ubuntu-latest - strategy: - matrix: - java_version: ['openjdk-11-jdk', 'openjdk-17-jdk', 'openjdk-18-jdk', 'openjdk-19-jdk'] - - steps: - - uses: actions/checkout@v3 - with: - path: src/fastddsgen - - - uses: ./src/fastddsgen/.github/actions/install-apt-packages - with: - java-version: ${{ matrix.java_version }} - - uses: ./src/fastddsgen/.github/actions/install-python-packages - - uses: ./src/fastddsgen/.github/actions/fetch-fastddsgen-repos - - - name: Get minimum supported version of CMake - uses: lukka/get-cmake@latest - with: - cmakeVersion: 3.16.3 - - name: Use cmake - run: cmake --version - - - name: Setup ccache - uses: Chocobo1/setup-ccache-action@v1 - - - name: Build workspace - run: | - colcon build --event-handlers=console_direct+ --cmake-args -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache - - - name: Build fastddsgen - run: | - cd src/fastddsgen - ./gradlew assemble - - - name: Test fastddsgen - run: | - source install/local_setup.bash - cd src/fastddsgen - ./gradlew test diff --git a/.github/workflows/config/build.meta b/.github/workflows/config/build.meta new file mode 100644 index 00000000..bf171319 --- /dev/null +++ b/.github/workflows/config/build.meta @@ -0,0 +1,7 @@ +names: + fastdds: + cmake-args: + - "-DEPROSIMA_BUILD_TESTS=ON" + fastdds_python: + cmake-args: + - "-DBUILD_TESTING=ON" diff --git a/.github/workflows/config/test.repos b/.github/workflows/config/test.repos new file mode 100644 index 00000000..5052ee82 --- /dev/null +++ b/.github/workflows/config/test.repos @@ -0,0 +1,5 @@ +repositories: + googletest-distribution: + type: git + url: https://github.com/google/googletest.git + version: release-1.11.0 diff --git a/.github/workflows/reusable-ubuntu-ci.yml b/.github/workflows/reusable-ubuntu-ci.yml new file mode 100644 index 00000000..8ebaf05d --- /dev/null +++ b/.github/workflows/reusable-ubuntu-ci.yml @@ -0,0 +1,214 @@ +name: Fast DDS Gen Ubuntu CI reusable workflow + +on: + workflow_call: + inputs: + os-version: + description: 'The OS image for the workflow' + required: true + type: string + java-version: + description: 'The Java version to be used' + required: true + type: string + label: + description: 'ID associated to the workflow' + required: true + type: string + fastddsgen-branch: + description: 'Fast DDS Gen branch to be used' + required: true + type: string + fastdds-branch: + description: 'Branch or tag of Fast DDS repository' + required: false + type: string + default: '2.10.x' + fastcdr-branch: + description: 'Branch or tag of Fast CDR repository' + required: false + type: string + default: '1.0.x' + fastdds-python-branch: + description: 'Branch or tag of Fast DDS Python repository' + required: false + type: string + default: '1.2.x' + discovery-server-branch: + description: 'Branch or tag of Discovery Server repository' + required: false + type: string + default: 'v1.2.1' + run-build: + description: 'Build Fast DDS Gen' + required: false + type: boolean + default: true + run-tests: + description: 'Run test suite of Fast DDS Gen' + required: false + type: boolean + default: true + use-ccache: + description: 'Use CCache to speed up the build' + required: false + type: boolean + default: false +defaults: + run: + shell: bash + +jobs: + ubuntu-build-test: + runs-on: ${{ inputs.os-version }} + if: ${{ inputs.run-build == true }} + strategy: + fail-fast: false + matrix: + cmake-build-type: + - 'RelWithDebInfo' + steps: + - name: Add ci-pending label if PR + if: ${{ github.event_name == 'pull_request' }} + uses: eProsima/eProsima-CI/external/add_labels@v0 + with: + labels: ci-pending + number: ${{ github.event.number }} + repo: eProsima/Fast-DDS-Gen + + - name: Sync eProsima/Fast-DDS-Gen repository + uses: eProsima/eProsima-CI/external/checkout@v0 + with: + path: ${{ github.workspace }}/src/fastddsgen + ref: ${{ inputs.fastddsgen-branch }} + + - name: Install Fix Python version + uses: eProsima/eProsima-CI/external/setup-python@v0 + with: + python-version: '3.11' + + - name: Get minimum supported version of CMake + uses: eProsima/eProsima-CI/external/get-cmake@v0 + with: + cmakeVersion: 3.22.6 + + - name: Install apt packages + uses: eProsima/eProsima-CI/ubuntu/install_apt_packages@v0 + with: + packages: libasio-dev libtinyxml2-dev libssl-dev swig ${{ inputs.java-version }} + + - name: Configure Java to ${{ inputs.java-version }} + shell: bash + run: | + jv=$(echo ${{ inputs.java-version }} | sed -r 's/.*-([0-9]*)-.*/\1/g'); jvs=$(update-alternatives --list java | grep "$jv" | head -1); sudo update-alternatives --set java "$jvs" + jv=$(echo ${{ inputs.java-version }} | sed -r 's/.*-([0-9]*)-.*/\1/g'); jvs=$(update-alternatives --list javac | grep "$jv" | head -1); sudo update-alternatives --set javac "$jvs" + + - name: Install colcon + uses: eProsima/eProsima-CI/multiplatform/install_colcon@v0 + + - name: Install Python dependencies + uses: eProsima/eProsima-CI/multiplatform/install_python_packages@v0 + with: + packages: vcstool xmlschema xmltodict==0.13.0 jsondiff==2.0.0 pandas==1.5.2 + upgrade: false + + - name: Setup CCache + uses: eProsima/eProsima-CI/external/setup-ccache-action@v0 + if: ${{ inputs.use-ccache == true }} + with: + api_token: ${{ secrets.GITHUB_TOKEN }} + + - name: Get Fast DDS branch + id: get_fastdds_branch + uses: eProsima/eProsima-CI/ubuntu/get_related_branch_from_repo@v0 + with: + remote_repository: eProsima/Fast-DDS + fallback_branch: ${{ inputs.fastdds-branch }} + + - name: Get Fast CDR branch + id: get_fastcdr_branch + uses: eProsima/eProsima-CI/ubuntu/get_related_branch_from_repo@v0 + with: + remote_repository: eProsima/Fast-CDR + fallback_branch: ${{ inputs.fastcdr-branch }} + + - name: Get Fast DDS Python branch + id: get_fastdds_python_branch + uses: eProsima/eProsima-CI/ubuntu/get_related_branch_from_repo@v0 + with: + remote_repository: eProsima/Fast-DDS-python + fallback_branch: ${{ inputs.fastdds-python-branch }} + + - name: Get Discovery Server branch + id: get_discovery_server_branch + uses: eProsima/eProsima-CI/ubuntu/get_related_branch_from_repo@v0 + with: + remote_repository: eProsima/Discovery-Server + fallback_branch: ${{ inputs.discovery-server-branch }} + + - name: Download Fast CDR, Fast DDS Python, and Discovery Server + run: | + cd src + git clone -b ${{ steps.get_fastcdr_branch.outputs.deduced_branch }} https://github.com/eProsima/Fast-CDR.git fastcdr + git clone -b ${{ steps.get_fastdds_python_branch.outputs.deduced_branch }} https://github.com/eProsima/Fast-DDS-python.git fastdds_python + git clone -b ${{ steps.get_discovery_server_branch.outputs.deduced_branch }} https://github.com/eProsima/Discovery-Server.git discovery_server + cd .. + shell: bash + + - name: Download Fast DDS repo + uses: eProsima/eProsima-CI/external/checkout@v0 + with: + repository: eProsima/Fast-DDS + path: ${{ github.workspace }}/src/fastrtps + ref: ${{ steps.get_fastdds_branch.outputs.deduced_branch }} + + - name: Fetch Fast DDS dependencies + uses: eProsima/eProsima-CI/multiplatform/vcs_import@v0 + with: + vcs_repos_file: ${{ github.workspace }}/src/fastrtps/fastrtps.repos + destination_workspace: src + skip_existing: 'true' + + - name: Build fastddsgen + run: | + cd ${{ github.workspace }}/src/fastddsgen + ./gradlew assemble + echo "$(pwd)/scripts" >> ${{ github.path }} + + - name: Regenerate IDL files for Fast DDS, Fast DDS Python, and Discovery Server + run: | + cd ${{ github.workspace }}/src/fastrtps + ./utils/scripts/update_generated_code_from_idl.sh + cd - + + cd ${{ github.workspace }}/src/fastdds_python + ./utils/scripts/update_generated_code_from_idl.sh + cd - + + cd ${{ github.workspace }}/src/discovery_server + ./utils/scripts/update_generated_code_from_idl.sh + cd - + + - name: Fetch Fast DDS Gen CI dependencies + uses: eProsima/eProsima-CI/multiplatform/vcs_import@v0 + if: ${{ inputs.run-tests == true }} + with: + vcs_repos_file: ${{ github.workspace }}/src/fastddsgen/.github/workflows/config/test.repos + destination_workspace: src + skip_existing: 'true' + + - name: Colcon build + continue-on-error: false + uses: eProsima/eProsima-CI/multiplatform/colcon_build@v0 + with: + colcon_meta_file: ${{ github.workspace }}/src/fastddsgen/.github/workflows/config/build.meta + colcon_build_args_default: '--event-handlers=console_direct+' + cmake_build_type: ${{ matrix.cmake-build-type }} + workspace: ${{ github.workspace }} + + - name: Test fastddsgen + if: ${{ inputs.run-tests == true }} + run: | + source ${{ github.workspace }}/install/local_setup.bash + cd ${{ github.workspace }}/src/fastddsgen + ./gradlew test diff --git a/.github/workflows/ubuntu-ci.yml b/.github/workflows/ubuntu-ci.yml new file mode 100644 index 00000000..bc565013 --- /dev/null +++ b/.github/workflows/ubuntu-ci.yml @@ -0,0 +1,70 @@ +name: Fast DDS Gen Ubuntu CI + +on: + workflow_dispatch: + inputs: + fastddsgen-branch: + description: 'Fast DDS Gen branch to be used' + required: true + type: string + fastdds-branch: + description: 'Branch or tag of Fast DDS repository' + required: false + type: string + default: '2.10.x' + fastcdr-branch: + description: 'Branch or tag of Fast CDR repository' + required: false + type: string + default: '1.0.x' + fastdds-python-branch: + description: 'Branch or tag of Fast DDS Python repository' + required: false + type: string + default: '1.2.x' + discovery-server-branch: + description: 'Branch or tag of Discovery Server repository' + required: false + type: string + default: 'v1.2.1' + run-tests: + description: 'Run test suite of Fast DDS Gen' + required: false + type: boolean + default: true + use-ccache: + description: 'Use CCache to speed up the build' + required: false + type: boolean + default: false + + pull_request: + types: + - review_requested + paths-ignore: + - '**.md' + - '**.txt' + - '!**/CMakeLists.txt' + +concurrency: + group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} + cancel-in-progress: true + +jobs: + ubuntu-ci: + if: ${{ !(github.event_name == 'pull_request') || !contains(github.event.pull_request.labels.*.name, 'conflicts') }} + uses: ./.github/workflows/reusable-ubuntu-ci.yml + with: + # It would be desirable to have a matrix of ubuntu OS for this job, but due to the issue opened in this ticket: + # https://github.com/orgs/community/discussions/128118 , it has been set as a single OS job. + os-version: 'ubuntu-22.04' + java-version: 'openjdk-11-jdk' + label: 'ubuntu-ci-openjdk-11-jdk' + fastddsgen-branch: ${{ inputs.fastddsgen-branch || github.ref }} + fastdds-branch: ${{ inputs.fastdds-branch || '2.10.x' }} + fastcdr-branch: ${{ inputs.fastcdr-branch || '1.0.x' }} + fastdds-python-branch: ${{ inputs.fastdds-python-branch || '1.2.x' }} + discovery-server-branch: ${{ inputs.discovery-server-branch || 'v1.2.1' }} + run-build: ${{ !(github.event_name == 'pull_request') || !contains(github.event.pull_request.labels.*.name, 'skip-ci') }} + run-tests: ${{ (inputs.run-tests == true) || ((github.event_name == 'pull_request') && (!contains(github.event.pull_request.labels.*.name, 'no-test'))) }} + use-ccache: ${{ (inputs.use-ccache == true) || false }} diff --git a/RELEASE_SUPPORT.md b/RELEASE_SUPPORT.md new file mode 100644 index 00000000..a516194d --- /dev/null +++ b/RELEASE_SUPPORT.md @@ -0,0 +1,6 @@ +# Release support + + +Please, refer to the [master branch](https://github.com/eProsima/Fast-DDS-Gen/blob/master/RELEASE_SUPPORT.md) for the latest version of this document. + +For detailed information about the lifecycle of the different *Fast DDS* versions (and their corresponding counterpart in this repository), please refer to the [release support section of the Fast DDS repository](https://github.com/eProsima/Fast-DDS/blob/master/RELEASE_SUPPORT.md).