Skip to content

Update docs-build.yml#142958

Merged
shainaraskas merged 3 commits intoelastic:mainfrom
theletterf:theletterf-patch-1
Mar 3, 2026
Merged

Update docs-build.yml#142958
shainaraskas merged 3 commits intoelastic:mainfrom
theletterf:theletterf-patch-1

Conversation

@theletterf
Copy link
Copy Markdown
Member

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

@theletterf theletterf self-assigned this Feb 24, 2026
@theletterf theletterf added the Team:Docs Meta label for docs team label Feb 24, 2026
@elasticsearchmachine
Copy link
Copy Markdown
Collaborator

Pinging @elastic/core-docs (Team:Docs)

@elasticsearchmachine elasticsearchmachine added external-contributor Pull request authored by a developer outside the Elasticsearch team v9.4.0 labels Feb 24, 2026
@theletterf theletterf added >docs General docs changes v9.4.0 skip-transport-version-generation and removed external-contributor Pull request authored by a developer outside the Elasticsearch team v9.4.0 labels Feb 24, 2026
@theletterf
Copy link
Copy Markdown
Member Author

@shainaraskas @szabosteve Which folders should we include?

Copy link
Copy Markdown
Contributor

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

lgtm but let's please hold until tue so I can give my group a formal heads up

Comment on lines 19 to 20
path-pattern: docs/**
path-pattern-ignore: docs/changelog/**/*.yaml
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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?)

Copy link
Copy Markdown
Member Author

@theletterf theletterf left a comment

Choose a reason for hiding this comment

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

Good question! These are two different filtering layers that work independently:

  • path-pattern / path-pattern-ignore are inputs to the docs-builder reusable workflow. They control which changed files trigger the workflow (or get passed to the docs build). So path-pattern: docs/** with path-pattern-ignore: docs/changelog/**/*.yaml means "run when docs files change, but ignore changelog YAML files."
  • include-paths is 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.

@szabosteve szabosteve self-requested a review February 27, 2026 14:51
Copy link
Copy Markdown
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

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

LGTM!

@shainaraskas shainaraskas merged commit 42e14a9 into elastic:main Mar 3, 2026
26 of 34 checks passed
GalLalouche pushed a commit to GalLalouche/elasticsearch that referenced this pull request Mar 3, 2026
szybia added a commit to szybia/elasticsearch that referenced this pull request Mar 3, 2026
…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
  ...
shmuelhanoch pushed a commit to shmuelhanoch/elasticsearch that referenced this pull request Mar 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>docs General docs changes skip-transport-version-generation Team:Docs Meta label for docs team v9.4.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants