Conversation
|
Pinging @elastic/core-docs (Team:Docs) |
|
@shainaraskas @szabosteve Which folders should we include? |
shainaraskas
left a comment
There was a problem hiding this comment.
lgtm but let's please hold until tue so I can give my group a formal heads up
| path-pattern: docs/** | ||
| path-pattern-ignore: docs/changelog/**/*.yaml |
There was a problem hiding this comment.
how do these two interact with include-paths? assuming we could probably just kill them from the config (or does this control when the workflow is triggered at all?)
theletterf
left a comment
There was a problem hiding this comment.
Good question! These are two different filtering layers that work independently:
path-pattern/path-pattern-ignoreare inputs to thedocs-builderreusable workflow. They control which changed files trigger the workflow (or get passed to the docs build). Sopath-pattern: docs/**withpath-pattern-ignore: docs/changelog/**/*.yamlmeans "run when docs files change, but ignore changelog YAML files."include-pathsis a Vale-specific input. It controls which files actually get linted once the workflow is running. It's a second, independent filter applied only to the Vale linting step.
They're complementary, not redundant. path-pattern gates the whole workflow; include-paths narrows what Vale looks at within that run.
You could technically remove path-pattern-ignore if the only purpose was to skip linting those files, since include-paths already excludes anything outside docs/reference/** and docs/extend/**. But path-pattern-ignore also prevents the entire workflow from triggering on changelog-only PRs, which saves CI time.
…locations * upstream/main: (51 commits) ESQL: Remaining serialization tests (elastic#143470) Eagerly release resources in `TransportAwaitClusterStateVersionAppliedAction` (elastic#143477) Stop and relocate sliced reindex on shutdown (elastic#143183) Documentation for query_vector base64 parameter (elastic#142675) ES|QL: Fix LIMIT after all columns are dropped (elastic#143463) Update docs-build.yml (elastic#142958) Fix KnnIndexTester to work with byte vectors (elastic#143493) Fix IndexInputUtils.withSlice to produce native-safe MemorySegments on Java 21 (elastic#143479) CPS fix: include only relevant projects in the search response metadata (elastic#143367) apm-data: explicit map of timestamp.us to long (elastic#143173) [Inference API] Add custom headers for Azure OpenAI Service (elastic#142969) ESQL: Add name IDs to golden tests and fix synthetic names (elastic#143450) Add getUnavailableShards to BaseBroadcastResponse (elastic#143406) Add description to reindex API without sensitive info (elastic#143112) SQL: fix CLI tests (elastic#143451) ES|QL: Add note of future removal of FORK implicit LIMIT (elastic#143457) [Test] Randomly disable doc values skippers in time-series indices (elastic#143389) Improve pattern text downgrade license test (elastic#143102) [Transform] Stop transforms at the end of tests (elastic#139783) Mute org.elasticsearch.compute.lucene.read.ValueSourceReaderTypeConversionTests testLoadAll elastic#143471 ...
This PR adds support for Vale docs linting to the repository. Linting only triggers when Markdown files inside the docs folder are edited. Vale linting never blocks pull requests. For more information, refer to Vale linter.
Contributes to https://github.com/elastic/docs-content-internal/issues/660