Skip to content

Conversation

@gaurav-nelson
Copy link
Collaborator

This adds a bit relaxed version of Vale linting for PRs. For https://issues.redhat.com/browse/TELCODOCS-1327

  • It would only check if modified lines have any error and would add a comment to the PR. The check would always pass and won't stop people from merging PRs in case of false positives.
  • Only lists issues of type error and not warning and info.
  • Only checks for updated AsciiDoc and Markdown files under the following directories:
    • content/learn/*
    • content/patterns/*
    • content/contribute/*
    • modules/*

Sample comment would be similar to the following:

📝 Vale Linting Results

Vale found 3 issue(s) in the modified lines of this PR.

content/patterns/ansible-edge-gitops/cluster-sizing.adoc

  • Line 14: Keep one space between words in 'metal. For'. [RedHat.Spacing] (error)

content/patterns/ansible-edge-gitops/getting-started.adoc


This comment was automatically generated by Vale on the modified lines.

This PR is part 2 of the change. I still need to add configuration and updates to the OpenShift CI. Please see the Jira issue for more details.

@ocpdocs-previewbot
Copy link

🤖 Thu Sep 18 00:52:52 - The preview is ready at:
https://604--patternsdocs-pr.netlify.app

Copy link
Contributor

@mhjacks mhjacks left a comment

Choose a reason for hiding this comment

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

LGTM

@openshift-ci openshift-ci bot added the lgtm label Sep 18, 2025
@gaurav-nelson gaurav-nelson merged commit a5e03e2 into validatedpatterns:main Sep 19, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants