Skip to content

Check the Vale pipeline end to end - #2592

Closed
kcmartin wants to merge 2 commits into
mainfrom
vale-pipeline-check
Closed

kcmartin wants to merge 2 commits into
mainfrom
vale-pipeline-check

Conversation

@kcmartin

Copy link
Copy Markdown
Contributor

Checking the Vale pipeline end to end after #2590, #2591 and https://github.com/superfly/docs-tracking/issues/375. Not for merge on its own.

Neither earlier PR proved the whole path: #2590 produced an annotation, but from a whole-repo run narrowed by filter_mode: file, and #2591 passed the correct file list but had no findings left to report.

This PR changes 3 prose files over 2 commits, fixing one finding in each and deliberately leaving the rest. Vale locally says the remaining findings are:

blueprints/shared-nothing.mdx:195  proselint.Needless    outsized
blueprints/shared-nothing.mdx:282  Fly.WordList          click on
blueprints/shared-nothing.mdx:350  Fly.WordList          in order to
blueprints/shared-nothing.mdx:440  Fly.WordList          a.k.a
app-guides/kong-api-gateway.mdx:182  Fly.WordList        functionality
app-guides/kong-api-gateway.mdx:319  Fly.WordList        functionality
js/frameworks/meteor.mdx:136       proselint.Annotations 'NOTE' left in text

So CI should produce 7 annotations on those lines, a 3 file list in the log, and no fallback or merge base warning.

@mintlify

mintlify Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
fly-io 🟢 Ready View Preview Oct 21, 2026, 7:28 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@kcmartin

Copy link
Copy Markdown
Contributor Author

Confirmed. https://github.com/superfly/docs/actions/runs/39661667675 produced all 7 predicted annotations, on the exact files and lines, and nothing extra:

[command]vale --output=JSON app-guides/kong-api-gateway.mdx blueprints/shared-nothing.mdx js/frameworks/meteor.mdx
js/frameworks/meteor.mdx:136         failure  'NOTE' left in text
blueprints/shared-nothing.mdx:195    warning  Prefer 'outsize' over 'outsized'
blueprints/shared-nothing.mdx:282    warning  'click' or 'click in' instead of 'click on'
blueprints/shared-nothing.mdx:350    warning  'to' instead of 'in order to'
blueprints/shared-nothing.mdx:440    warning  'or' or 'also known as' instead of 'a.k.a'
app-guides/kong-api-gateway.mdx:182  warning  'capability' or 'feature' instead of 'functionality'
app-guides/kong-api-gateway.mdx:319  warning  'capability' or 'feature' instead of 'functionality'

Three files in the command, over two commits, with no fallback warning and no merge base warning. Log is 543 lines instead of 3,014, since it no longer lints the whole repo. The two remaining .github annotations are GitHub's own Node 20 and ubuntu-latest notices, not Vale.

One thing worth knowing: meteor.mdx:136 is an error-level rule and still came through as failure, but the check passed anyway because of fail_on_error: false. Nothing Vale finds can fail a PR right now.

@kcmartin

Copy link
Copy Markdown
Contributor Author

Closing as this was mainly for testing

@kcmartin kcmartin closed this Oct 21, 2026

This branch was successfully deployed

1 active deployment
staging — 804b0e5b Deployed Oct 21, 2026 by mintlify[bot]
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.

1 participant