[ci] build next docs in PRs when relevant files change #149991
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
spalger
force-pushed
the
implement/next-docs-pipeline-step
branch
10 times, most recently
from
6a6ce4c to
39f2db0
Compare
spalger
force-pushed
the
implement/next-docs-pipeline-step
branch
from
39f2db0 to
0d1327c
Compare
…r/kibana into implement/next-docs-pipeline-step
spalger
added
Team:Operations
|
Pinging @elastic/kibana-operations (Team:Operations) |
jbudz
reviewed
Feb 2, 2023
| @@ -0,0 +1,5 @@ | |||
| # @kbn/validate-next-docs-cli | |||
|
|
|||
| Clone a bunch of repos needed to build the next-docs with the latest version of the changes in the repo. This is only used for validating changes in CI with full validation of all IDs. This isn't intended for local development (except for debugging). | |||
There was a problem hiding this comment.
This seems like it could cause Kibana CI to break in a way we can't fix via other repo's docs. Is there a way to limit this to only build kibana docs?
There was a problem hiding this comment.
It could, but at this point Kibana is the only repo without a docs block on PRs so we're actually the ones breaking things in other repos. Additionally this would only impact people working on docs, so I'm not super concerned about it personally.
There was a problem hiding this comment.
Additionally, no, there isn't any way to validate our docs without building everything. It's a flaw in the current docs system but it's one the docs team is aware of.
spalger
commented
Feb 3, 2023
added 4 commits
February 9, 2023 15:42
…r/kibana into implement/next-docs-pipeline-step
|
@glitteringkatie I think these changes should resolve the final issues so we can get this in before I leave. Sorry, very busy week. |
💚 Build Succeeded
Metrics [docs]
History
To update your PR or re-run it, just comment with: |
kibanamachine
added
v8.8.0
backport:skip
jloleysens
added a commit
to jloleysens/kibana
that referenced
this pull request
Feb 10, 2023
* main: (115 commits) [Custom branding] Add custom logo to space selector (elastic#150284) [api-docs] 2023-02-10 Daily api_docs build (elastic#150831) [ci] build next docs in PRs when relevant files change (elastic#149991) [codeowners] allow overrides to take higher precedence (elastic#150821) [docs] Remove kibDevDocsOpsPluginDiscovery (elastic#150788) [Fleet] Fix max 20 installed integrations returned from Fleet API (elastic#150780) [maps] fix Changing resolutions on Heat map layer throws error in console (elastic#150761) fixes Failing ES Promotion: X-Pack API Integration Tests x-pack/test/api_integration/apis/maps/get_grid_tile.js (elastic#150768) [Synthetics] adjust overview scrolling e2e (elastic#150774) [Security Solution] Fixes bulk close alerts from exception flyout type bug (elastic#150765) Upgrade EUI to v74.1.0 (elastic#150235) [skip ci] Fix labeling for Infrastructure UI (elastic#150571) [Enterprise Search] Move pipelines modal to flyout (elastic#150727) [Security Solution] fix flaky endpoint tests (elastic#150652) Fixes the space selector page layout (elastic#150503) [Dashboard] [Navigation] Fix mount point bug (elastic#150507) [Infrastructure UI] Track host cloud provider on table entry click (elastic#150685) [Dashboard Usability] Moves scrollbar to panel section (elastic#145628) [Maps] fixes Kibana maps shows MVT borders if the geometry border style is greater than 1 (elastic#150497) [Cloud Posture][Dashboard] dashboard re-design enhancements (elastic#150394) ...
|
🤩 Thank you all!! |
jbudz
added a commit
that referenced
this pull request
Oct 17, 2024
Currently CI is not run on pull requests with `dev_docs` only changes. This was implemented in #133087, where at the time we were not running any validation. Validation was later added in #149991, but the skip criteria was not updated. This removes the skip criteria, allowing our validation checks to run on all `dev_docs` changes.
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.
After chatting with @KOTungseth, @scottybollinger, and @glitteringkatie we've decided to add a CI step to the Kibana repo that will run when changes to next-doc related code is made. This step will checkout the repository containing configuration for the docs.elastic.dev website (which is currently private, sorry) and then ensure that the build can be completed with a local copy of all the repositories. It does this by reading the
config/content.jsfiles and cloning all of the repositories listed, then rewriting the content.js file with a map telling the build system to read files from the local repos (which are pre-cached by the packer cache job) and the local Kibana repo (which represents the changes in the PR).This script also runs locally by running
node scripts/validate_next_docs.