Add Doxygen config and GitHub Pages deployment#365
Open
rsasaki0109 wants to merge 1 commit intodevelop-ros2from
Open
Add Doxygen config and GitHub Pages deployment#365rsasaki0109 wants to merge 1 commit intodevelop-ros2from
rsasaki0109 wants to merge 1 commit intodevelop-ros2from
Conversation
Comment on lines
+3
to
+7
| on: | ||
| push: | ||
| branches: | ||
| - develop-ros2 | ||
| - main-ros2 |
There was a problem hiding this comment.
This workflow is configured to run on pushes to both develop-ros2 and main-ros2 branches (lines 3-7), but the deployment step only executes for develop-ros2 (line 26). This means the workflow will run on main-ros2 but won't deploy anything, which is inefficient.
Consider either:
- Removing
main-ros2from the trigger branches if deployment is only intended fordevelop-ros2 - Adding a separate deployment condition for
main-ros2if you want to deploy from that branch too (perhaps to a different directory)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Doxyfileto generate HTML API documentation from all C++ headers/sources.github/workflows/docs.ymlthat generates and deploys docs to GitHub Pages on push todevelop-ros2Result
After merge, API docs will be published at
https://mapiv.github.io/eagleye/