Skip to content

Scope Vale linting for integration content#19235

Open
theletterf wants to merge 3 commits into
mainfrom
fabri/integrations-vale-yaml-scope
Open

Scope Vale linting for integration content#19235
theletterf wants to merge 3 commits into
mainfrom
fabri/integrations-vale-yaml-scope

Conversation

@theletterf
Copy link
Copy Markdown
Member

@theletterf theletterf commented May 27, 2026

Summary

  • Restrict the integrations Vale workflow to user-facing package docs and metadata.
  • Include fallback packages/*/docs/README.md files only when a package lacks _dev/build/docs/README.md.
  • Opt integrations into YAML linting through .vale-overrides.ini.

Test plan

  • actionlint .github/workflows/vale-lint.yml
  • ruby -e \"require 'yaml'; YAML.load_file('.github/workflows/vale-lint.yml')\"
  • Parsed .vale-overrides.ini with Python ConfigParser.

Fixes elastic/vale-rules#144

Made with Cursor

Limit Vale checks to user-facing integration docs and metadata, with YAML linting enabled through repo overrides.

Co-authored-by: GPT-5.5 <gpt-5.5@users.noreply.github.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
@theletterf theletterf requested a review from a team as a code owner May 27, 2026 10:53
@github-actions

This comment has been minimized.

@theletterf
Copy link
Copy Markdown
Member Author

@P1llus Please have a look.

Comment thread .github/workflows/vale-lint.yml Outdated
Comment thread .vale-overrides.ini
Comment thread .github/workflows/vale-lint.yml Outdated
Comment thread .github/workflows/vale-lint.yml Outdated
Use environment variables for GitHub context values, support nested package paths, and avoid package test fan-out for Vale override-only changes.

Co-authored-by: GPT-5.5 <gpt-5.5@users.noreply.github.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
@theletterf
Copy link
Copy Markdown
Member Author

theletterf commented May 27, 2026

@mrodm Addressed the review feedback in 50c4401176:

  • Moved github.repository and github.event.pull_request.number into GH_REPOSITORY and PR_NUMBER env vars before using them in the shell script.
  • Switched the Vale workflow trigger, selector, and vale-paths patterns from packages/*/... to packages/**/... so future nested package paths are handled.
  • Added .vale-overrides.ini to the Buildkite non-package-only skip lists in .buildkite/pull-requests.json and .buildkite/scripts/common.sh to avoid package test fan-out when only that override changes.

Validation run locally:

  • actionlint .github/workflows/vale-lint.yml.
  • ruby -e \"require 'yaml'; YAML.load_file('.github/workflows/vale-lint.yml')\" && jq empty .buildkite/pull-requests.json && bash -n .buildkite/scripts/common.sh.
  • Simulated file selection for both packages/nginx/... and packages/observability/nginx/... paths.

@elastic elastic deleted a comment from elasticmachine May 27, 2026
@theletterf theletterf closed this May 27, 2026
@theletterf theletterf reopened this May 27, 2026
@github-actions

This comment has been minimized.

@theletterf
Copy link
Copy Markdown
Member Author

/test

@elasticmachine
Copy link
Copy Markdown

⏳ Build in-progress, with failures

Failed CI Steps

@github-actions
Copy link
Copy Markdown
Contributor

TL;DR

Buildkite Check integrations netbox failed in build 43625, but the captured log only contains teardown/upload output and a generic exit status 1, so the concrete failing test/assertion is not present in available evidence. Immediate action: inspect the uploaded netbox-system-*.xml test result artifact (or rerun with full step logs) to get the exact failure signature.

Remediation

  • Download and inspect build/test-results/netbox-system-1779896786444958667.xml from build 43625 artifacts and identify the first failing testcase/error block.
  • Apply a targeted fix based on that testcase, then re-run Check integrations netbox.
Investigation details

Root Cause

The provided step log is truncated to post-failure teardown and artifact upload, so root cause cannot be directly attributed to package code, test logic, dependency, or infra from this dataset alone.

PR #19235 changes are limited to:

  • .github/workflows/vale-lint.yml
  • .vale-overrides.ini
  • .buildkite/pull-requests.json
  • .buildkite/scripts/common.sh

No packages/netbox/** files are changed in this PR diff.

Evidence

73. --- [netbox] failed
76. 🚨 Error: The command exited with status 1
78. user command error: exit status 1
  • The same log confirms test result artifacts were uploaded, including:
    • build/test-results/netbox-system-1779896786444958667.xml
    • build/test-results/netbox-asset-1779896708215805379.xml
    • build/test-results/netbox-pipeline-1779896710092596960.xml

Verification

  • Not run locally here; the actionable missing signal is the failing testcase/error payload from the uploaded XML artifact, which is not included in the captured log file.

Follow-up

If the failing testcase/error block is shared, it can be mapped directly to the responsible source path for a precise patch recommendation.


What is this? | From workflow: PR Buildkite Detective

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improving Vale Linting for integrations repo

3 participants