Skip to content

[CI] Run DocsBuild only when needed #1273

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

PatKamin
Copy link
Contributor

Oftentimes pushes to branches and PRs doesn't change anything in docs/ or include/ directories which influence the documentation build. This job takes ca. 1 minute to run with each push, so it's optimal to run it only when relevant changes were made.

Also, there is no need for other pr_push jobs to wait for docs to build. Developer can work on the docs and project build/tests in any order.

Description

Checklist

  • Code compiles without errors locally
  • All tests pass locally
  • CI workflows execute properly
  • CI workflows, not executed per PR (e.g. Nightly), execute properly
  • New tests added, especially if they will fail without my changes
  • Added/extended example(s) to cover this functionality
  • Extended the README/documentation
  • All newly added source files have a license
  • All newly added source files are referenced in CMake files
  • Logger (with debug/info/... messages) is used
  • All API changes are reflected in docs and def/map files, and are tested

@PatKamin PatKamin force-pushed the move-docsbuild branch 2 times, most recently from 8b6f185 to 6d9ec15 Compare April 15, 2025 20:11
Oftentimes pushes to branches and PRs doesn't change anything in docs/
or include/ directories which influence the documentation build. This
job takes ca. 1 minute to run with each push, so it's optimal to run it
only when relevant changes were made.

Also, there is no need for other pr_push jobs to wait for docs to build.
Developer can work on the docs and project build/tests in any order.
@PatKamin PatKamin marked this pull request as ready for review April 16, 2025 08:00
@PatKamin PatKamin requested a review from a team as a code owner April 16, 2025 08:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant