Fix Vale action configuration for GitHub PR reviews #3509
Conversation
This file contains hidden or 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
- Fix Vale action version from @reviewdog to @v2.1.1 - Add proper workflow permissions for PR interactions - Install mdx2vast globally for MDX format support - Simplify files parameter to comma-separated format - Add debug step to verify Vale and mdx2vast setup - Enhance .vale.ini with better file patterns and warning level - Expand vocabulary with nf-core ecosystem terms - Add Vale to pre-commit hooks for local development 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
✅ Deploy Preview for nf-core-main-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
mashehu
reviewed
Sep 25, 2025
edmundmiller
force-pushed
the
fix/vale-configuration-improvements
branch
from
a62cdae to
1e6e83d
Compare
Successfully forked and enhanced mdx2vast to support nf-core's custom
remark directive syntax like :::tip{title='Examples' collapse}.
Changes:
- Fork mdx2vast from jdkato/mdx2vast to edmundmiller/mdx2vast
- Add micromark-extension-directive and mdast-util-directive dependencies
- Implement containerDirective, leafDirective, textDirective handling
- Convert directives to HTML divs with proper classes and data attributes
- Update Vale workflow to use custom fork instead of original package
This resolves the MDX parsing runtime errors that were preventing Vale
from processing .mdx files with custom Astro directive syntax. Vale now
successfully lints MDX content and provides proper style feedback.
edmundmiller
force-pushed
the
fix/vale-configuration-improvements
branch
7 times, most recently
from
0191a3a to
12f1e7f
Compare
edmundmiller
force-pushed
the
fix/vale-configuration-improvements
branch
from
12f1e7f to
1a86a29
Compare
Contributor
Author
|
We can either turn off the "pre-commit run all" or make a follow-up PR, or ignore all of the current errors or fix them. Whatever y'all want to do. |
Contributor
|
@nf-core-bot fix linting |
Contributor
Author
|
I didn't know you could do that! 👀 |
Member
|
This looks good to me... if it's still too noisy, we can roll it back. |
| nf-core | ||
| Nextflow | ||
| Seqera | ||
| SeqeraLabs |
Member
There was a problem hiding this comment.
Suggested change
| SeqeraLabs | |
| SeqeraLabs |
I'm not sure we need this, but it's not a blocker.
Contributor
Author
There was a problem hiding this comment.
Oh we should actually not accept that.
Maybe in the links to GitHub repos?
Member
There was a problem hiding this comment.
I don't actually know how Vale reconciles code. If we are referring to SeqeraLabs, it's probably as part of a repository, so it should be in seqeralabs. Anything else should be Seqera.
christopher-hakkaart
approved these changes
Oct 5, 2025
github-project-automation
bot
moved this from Todo
to In Progress
in nf-core infrastructure projects
edmundmiller
force-pushed
the
fix/vale-configuration-improvements
branch
from
c4f5a6e to
5606726
Compare
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.
Summary
mdx2vastChanges
GitHub Workflow (.github/workflows/linting.yml)
@reviewdogto@v2.1.1pull-requests: writeandchecks: writefor PR interactionsmdx2vastglobally to enable Vale MDX parsingVale Configuration (.vale.ini)
Custom Vocabulary (.github/styles/config/vocabularies/Docs/accept.txt)
Pre-commit Integration (.pre-commit-config.yaml)
Why These Changes
The original issue was that Vale wasn't showing up in GitHub PR reviews. Root causes:
@reviewdogis not a valid Vale action versionmdx2vastto parse .mdx files${{inputs.DOC_SRC}}was undefined@netlify /docs/contributing/project_proposals