Avoid CI run when only changes files in doc/#1817
Merged
Merged
Conversation
yhmtsai
added
1:ST:ready-for-review
ginkgo-bot
added
the
reg:ci-cd
pratikvn
approved these changes
Mar 31, 2025
Member
pratikvn
left a comment
pratikvn
left a comment
There was a problem hiding this comment.
LGTM! I am fine with mirroring only when it is main/develop. I am also fine with doing that from the github side.
yhmtsai
force-pushed
the
doc_norun_ci
branch
2 times, most recently
from
b41bd00 to
783aedc
Compare
yhmtsai
added
1:ST:skip-full-test
1:ST:no-changelog-entry
yhmtsai
added
1:ST:ready-to-merge
Note. Github action need to fulfill path and branch condition at the same time Github does not support two push in the same file. We split it into two file such that we always mirror on the major branches but only mirror when more than doc change in the other branches
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
3 participants
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.
After #1813 , I believe we will have more PR just improving documentation.
All documentation build are handled in readthedoc, so we do not need to occupy our CI for that.
Some are still working like pre-commit check, spell check, pr label, etc without the compilation need.
Others like gitlab, osx, intel, abidiff which require compile ginkgo will not be executed when only changes the file under doc/
If some changes in other place or it is our main/develop branch, the CI still performs as usual.
gitlab ci currently does not support the ignore pattern unfortunately (related issue: https://gitlab.com/gitlab-org/gitlab/-/issues/198688)
We need to use the opposite way to check whether others file changed or not. It definitely goes crazy if we have more conditions. (see the gitlab changes)
Github action has path_ignore which makes thing clear.
I also want to avoid mirror when it is not main/develop and no changes out of doc in github action rather than doing that in gitlab side. any comments on it?
It is done.
When use branch and path condition, both are required to be satisfied for running a job.
Also Github action does not allow two push event in one file, so I split it into two: one for the major branches, which always mirror, and the other for the rest, which only mirror when there are more than documentation changes