Skip to content

Only build documentation if files under docs folder changed #16131

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

Only build documentation if files under docs folder changed #16131

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
# - ubu: ubuntu
# - ems: Emscripten
version: 2.1


parameters:
ubuntu-2004-docker-image:
type: string
Expand Down Expand Up @@ -35,9 +37,17 @@ parameters:
evm-version:
type: string
default: prague
# Path filtering parameters
run-main-workflow:
type: boolean
default: true
run-docs-workflow:
type: boolean
default: false

orbs:
win: circleci/[email protected]
path-filtering: circleci/[email protected]

commands:
matrix_notify_unless_pr:
Expand Down Expand Up @@ -1872,7 +1882,23 @@ jobs:
workflows:
version: 2

setup:
jobs:
- path-filtering/filter:
name: filter-docs
mapping: |
docs/.* run-docs-workflow true run-main-workflow false
# FIXME: << pipeline.git.base_revision >> seems to be empty sometimes so for now we are using the develop branch as base
base-revision: develop
config-path: .circleci/config.yml
Copy link
Member Author

@r0qs r0qs Jul 22, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Apparently, we cannot use the same config for different logics, so we will need to split the configuration in 3 to be able to perform such separation of workflows. Basically, we will have a setup configuration in config.yml and more two, one for code changes and one for docs. We may add more later. See: https://circleci.com/docs/using-dynamic-configuration/#generate-a-config-file-based-on-modified-files


docs:
when: << pipeline.parameters.run-docs-workflow >>
jobs:
- b_docs: *requires_nothing

main:
when: << pipeline.parameters.run-main-workflow >>
jobs:
# basic checks
- chk_spelling: *requires_nothing
Expand All @@ -1887,8 +1913,6 @@ workflows:
- t_ubu_pyscripts: *requires_nothing
- t_win_pyscripts: *requires_nothing

# build-only
- b_docs: *requires_nothing
- b_ubu_ossfuzz: *requires_nothing
- b_ubu_2204: *requires_nothing
- b_ubu_2204_clang: *requires_nothing
Expand Down