Skip to content

Conversation

@mergify
Copy link

@mergify mergify bot commented Jun 5, 2024

Description

This PR makes the RDT generation to fail if either of the doxygen or swig commands fails. Not checking them was causing the documentation to build with API reference errors.

@Mergifyio backport 2.14.x 2.13.x 2.10.x 2.6.x

Related implementation PR:

NOTE: As RTD build is not ready to take the appropriate Fast DDS branch and will choose master, the build will failed until eProsima/Fast-DDS#4896 is merged. I've verified on a Ubuntu 20.04 docker that the doxygen is generated without errors with that Fast DDS PR.

Contributor Checklist

  • Commit messages follow the project guidelines.
  • N/A: Code snippets related to the added documentation have been provided.
  • Documentation tests pass locally.
  • Applicable backports have been included in the description.

Reviewer Checklist

  • The PR has a milestone assigned.
  • The title and description correctly express the PR's purpose.
  • Check contributor checklist is correct.
  • CI passes without warnings or errors.

This is an automatic backport of pull request #795 done by [Mergify](https://mergify.com).

@JesusPoderoso JesusPoderoso added this to the v2.13.6 milestone Jun 5, 2024
@EduPonz
Copy link

EduPonz commented Jul 3, 2024

This shall include changes similar to those introduced in:

@JesusPoderoso JesusPoderoso force-pushed the mergify/bp/2.13.x/pr-795 branch from 87eb73a to f657d44 Compare July 3, 2024 10:17
EduPonz and others added 2 commits July 3, 2024 12:17
Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 0974196)
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 0974196)

* Refs #21114: Remove unsued Doxyfile EXAMPLE_PATH

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fix Fast DDS Python API reference warnings regarding Qos aliases

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fail generation when docutils errors

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Use correct branches of Fast DDS and Fast DDS Python in RTD

Signed-off-by: eduponz <eduardoponz@eprosima.com>

---------

Signed-off-by: eduponz <eduardoponz@eprosima.com>
Co-authored-by: Eduardo Ponz Segrelles <eduardoponz@eprosima.com>
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
@JesusPoderoso JesusPoderoso force-pushed the mergify/bp/2.13.x/pr-795 branch from f657d44 to ea53edb Compare July 3, 2024 10:17
@JesusPoderoso JesusPoderoso self-requested a review July 3, 2024 10:17
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
@JesusPoderoso JesusPoderoso force-pushed the mergify/bp/2.13.x/pr-795 branch from ea53edb to fd27b9f Compare July 3, 2024 10:25
@JesusPoderoso JesusPoderoso requested review from JesusPoderoso and removed request for JesusPoderoso July 3, 2024 10:25
@JesusPoderoso
Copy link
Contributor

Fast DDS docs CI has passed (see here and here), reverting commit and skipping CI.

This reverts commit fd27b9f.

Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
@JesusPoderoso JesusPoderoso added skip-ci Automatically pass CI and removed ci-pending labels Jul 3, 2024
Copy link
Contributor

@JesusPoderoso JesusPoderoso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@EduPonz EduPonz merged commit f0dce94 into 2.13.x Jul 3, 2024
@EduPonz EduPonz deleted the mergify/bp/2.13.x/pr-795 branch July 3, 2024 10:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip-ci Automatically pass CI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants