ci: documentation workflow optimizations. #14372
Merged
Conversation
This file contains 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
github-actions
bot
added
Area: CI
Size: S
|
I think there's another opportunity for optimization on this same goal; the Build workflow probably does not need to be triggered for this change (as far as I am aware). The |
|
Can you also please @linguini1 add commit that removes LaTeX packages installation and PDF generation? This will definitely save up the resources, I will add PDF generation on website repo next month when we manage the CI overuse with success first :-) |
…on subdirectory has modifications, and does not build pdfs.
linguini1
force-pushed
the
documentation-workflow
branch
from
92741ed to
fe77e1c
Compare
cederom
approved these changes
Oct 16, 2024
cederom
changed the title
acassis
approved these changes
Oct 16, 2024
hartmannathan
approved these changes
Oct 16, 2024
xiaoxiang781216
approved these changes
Oct 17, 2024
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
This change to the Documentation workflow adds the
pathsfilter so that the GitHub workflow is only run whenever a path matchingDocumentation/**is modified. It also removes the PDF building step, which is not necessary since Documentation is built on the NuttX website.Note from @cederom: We got final warning from Apache on exceeding CI usage and need find savings! This subject is discussed on dev@ mailing list.
Impact
This will reduce the number of unnecessary Documentation workflow runs being performed for PRs that do not modify the documentation and thus do not require a rebuild. It also removes unnecessary building of PDF documents, which speeds up the workflow.
Since building the Documentation takes about 13 minutes on average, this should considerably reduce the amount of time the NuttX repository is using in GitHub workflows, bringing us closer to being within the limit the Apache Foundation has set for workflow usage.
Testing
Since this change only modifies the GitHub workflow, testing is performed by verifying that this PR (containing the updated workflow) will not trigger the Documentation workflow since nothing under the
Documentation/sub-directory was modified.