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.

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

[21114] Check suprocess return codes on RDT generation (backport #795) #796

Merged
merged 5 commits into from
Jul 3, 2024

Conversation

mergify[bot]
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.14.2 milestone Jun 5, 2024
@EduPonz EduPonz modified the milestones: v2.14.2, v2.14.3 Jun 21, 2024
@EduPonz
Copy link

EduPonz commented Jul 2, 2024

This PR depends on the following PRs:

RTD job will not pass until those are merged, as RTD cannot be hinted to take the corresponding branches.

@EduPonz EduPonz merged commit 664ea54 into 2.14.x Jul 3, 2024
4 checks passed
@EduPonz EduPonz deleted the mergify/bp/2.14.x/pr-795 branch July 3, 2024 09:31
JesusPoderoso pushed a commit that referenced this pull request Jul 3, 2024
* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)

* Refs #21114: Remove unsued Doxyfile EXAMPLE_PATH

Signed-off-by: eduponz <[email protected]>

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

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Fail generation when docutils errors

Signed-off-by: eduponz <[email protected]>

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

Signed-off-by: eduponz <[email protected]>

---------

Signed-off-by: eduponz <[email protected]>
Co-authored-by: Eduardo Ponz Segrelles <[email protected]>
JesusPoderoso pushed a commit that referenced this pull request Jul 3, 2024
* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)

* Refs #21114: Remove unsued Doxyfile EXAMPLE_PATH

Signed-off-by: eduponz <[email protected]>

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

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Fail generation when docutils errors

Signed-off-by: eduponz <[email protected]>

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

Signed-off-by: eduponz <[email protected]>

---------

Signed-off-by: eduponz <[email protected]>
Co-authored-by: Eduardo Ponz Segrelles <[email protected]>
Signed-off-by: JesusPoderoso <[email protected]>
@EduPonz EduPonz modified the milestones: v2.14.3, v2.14.2 Jul 3, 2024
EduPonz added a commit that referenced this pull request Jul 3, 2024
* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)
Signed-off-by: JesusPoderoso <[email protected]>

* Check suprocess return codes on RDT generation (#795) (#796)

* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)

* Refs #21114: Remove unsued Doxyfile EXAMPLE_PATH

Signed-off-by: eduponz <[email protected]>

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

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Fail generation when docutils errors

Signed-off-by: eduponz <[email protected]>

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

Signed-off-by: eduponz <[email protected]>

---------

Signed-off-by: eduponz <[email protected]>
Co-authored-by: Eduardo Ponz Segrelles <[email protected]>
Signed-off-by: JesusPoderoso <[email protected]>

* Refs #21114: TODO DROP - Check against Fast DDS branch

Signed-off-by: JesusPoderoso <[email protected]>

* Revert "Refs #21114: TODO DROP - Check against Fast DDS branch"

This reverts commit fd27b9f.

Signed-off-by: JesusPoderoso <[email protected]>

---------

Signed-off-by: eduponz <[email protected]>
Signed-off-by: JesusPoderoso <[email protected]>
Co-authored-by: Eduardo Ponz Segrelles <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: JesusPoderoso <[email protected]>
EduPonz added a commit that referenced this pull request Jul 3, 2024
Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)

Check suprocess return codes on RDT generation (#795) (#796)

* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)

* Refs #21114: Remove unsued Doxyfile EXAMPLE_PATH

Signed-off-by: eduponz <[email protected]>

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

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Fail generation when docutils errors

Signed-off-by: eduponz <[email protected]>

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

Signed-off-by: eduponz <[email protected]>

---------

Signed-off-by: eduponz <[email protected]>
Co-authored-by: Eduardo Ponz Segrelles <[email protected]>
EduPonz added a commit that referenced this pull request Jul 3, 2024
* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)

Check suprocess return codes on RDT generation (#795) (#796)

* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)

* Refs #21114: Remove unsued Doxyfile EXAMPLE_PATH

Signed-off-by: eduponz <[email protected]>

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

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Fail generation when docutils errors

Signed-off-by: eduponz <[email protected]>

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

Signed-off-by: eduponz <[email protected]>

---------

Signed-off-by: eduponz <[email protected]>
Co-authored-by: Eduardo Ponz Segrelles <[email protected]>

* Set English as doc language

Signed-off-by: eduponz <[email protected]>

---------

Signed-off-by: eduponz <[email protected]>
Co-authored-by: Eduardo Ponz Segrelles <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants