Skip to content
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

[CI] skip stages if only docs changes #18315

Merged
merged 16 commits into from
May 8, 2020
Merged

[CI] skip stages if only docs changes #18315

Changes from 3 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
af05adb
ci: run docs if docs changes only
v1v May 6, 2020
3ab19a3
chore: for testing purposes
v1v May 6, 2020
716c4ec
Revert "chore: for testing purposes"
v1v May 6, 2020
407cc54
ci: asciidoc and png files to be searched and enable the linting to v…
v1v May 6, 2020
e5cb6e3
ci: skip will only affect PRs if they got changes in those files
v1v May 6, 2020
b7fd9fa
chore: for testing purposes
v1v May 6, 2020
3d1439d
Update Jenkinsfile
v1v May 6, 2020
c47f33d
ci: if rather than ternaries
v1v May 6, 2020
a401c83
chore: for testing purposes.
v1v May 6, 2020
37d36dc
chore: for testing purposes
v1v May 6, 2020
b5b3cdf
chore: for testing purposes
v1v May 7, 2020
7c9e214
ci: fix typo and regex for testing
v1v May 8, 2020
0cd6953
chore: revert the testing regex
v1v May 8, 2020
9cd5746
Revert "chore: for testing purposes"
v1v May 8, 2020
d03d581
Revert "chore: for testing purposes."
v1v May 8, 2020
ac3a586
ci: refactored just a bit
v1v May 8, 2020
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
12 changes: 12 additions & 0 deletions Jenkinsfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,19 @@ pipeline {
}
stage('Lint'){
options { skipDefaultCheckout() }
when {
beforeAgent true
expression { return env.ONLY_DOCS == "false" }
}
v1v marked this conversation as resolved.
Show resolved Hide resolved
steps {
makeTarget("Lint", "check")
}
}
stage('Build and Test'){
when {
beforeAgent true
expression { return env.ONLY_DOCS == "false" }
}
failFast false
parallel {
stage('Elastic Agent x-pack'){
Expand Down Expand Up @@ -1100,6 +1108,10 @@ def loadConfigEnvVars(){
generatorPatterns.addAll(getVendorPatterns('generator/common/beatgen'))
generatorPatterns.addAll(getVendorPatterns('metricbeat/beater'))
env.BUILD_GENERATOR = isChangedOSSCode(generatorPatterns)

// Skip all the stages for PRs with changes in the docs only
env.ONLY_DOCS = !params.runAllStages &&
isGitRegionMatch(patterns: [ '^docs/.*' ], shouldMatchAll: true)
Copy link
Contributor

Choose a reason for hiding this comment

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

Will this catch changes to files with paths such as ./auditbeat/build/docs/shared/settings60.asciidoc?

Copy link
Contributor

@ycombinator ycombinator May 6, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Additionally there are also "source" doc files such as ./filebeat/docs/modules/apache.asciidoc. So I'm wondering if this check needs be more about catching changes to any files (regardless of path) that end in .asciidoc?

Copy link
Member Author

Choose a reason for hiding this comment

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

That's indeed a good point, I actually thought it was just this initial PR, and then I found I missed the make update, so working on supporting those particular scenarios too. Thanks for the heads up :) I just moved the PR to draft to work on it.

Regarding the files, I see png files too, I don't know if there are some other type of files. If no, then I can include it in the filter to be file based rather than folder based as you suggested

Copy link
Contributor

Choose a reason for hiding this comment

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

Good point re: png files. And, as you said, there might be others too.

How about we start with asciidoc for now, since those do change relatively often, compared to other "non-code" types. And maybe we can add more types later?

Copy link
Member Author

Choose a reason for hiding this comment

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

png is also in the list of allowed files, let's then plan the following support files, if any, with some follow-ups. :)

}

/**
Expand Down