Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce a workflow for linting with Vale #29477

Merged
merged 2 commits into from
Dec 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/doc-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ jobs:
key: q2maven-doc-${{ steps.get-date.outputs.date }}
- name: Build
run: |
./mvnw -Dquickly-ci -B -DskipDocs=false --settings .github/mvn-settings.xml install
./mvnw -DquicklyDocs -B --settings .github/mvn-settings.xml

- name: Build Docs
run: |
./mvnw -e -B --settings .github/mvn-settings.xml clean org.asciidoctor:asciidoctor-maven-plugin:process-asciidoc -pl docs -Ddocumentation-pdf
./mvnw -e -B --settings .github/mvn-settings.xml clean package -pl docs
33 changes: 33 additions & 0 deletions .github/workflows/vale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Linting with Vale
on:
pull_request:
paths:
- 'docs/src/main/asciidoc/**'
- '.github/workflows/vale.yml'

concurrency:
group: "workflow = ${{ github.workflow }}, ref = ${{ github.event.ref }}, pr = ${{ github.event.pull_request.id }}"
cancel-in-progress: ${{ github.event_name == 'pull_request' || github.repository != 'quarkusio/quarkus' }}

jobs:
vale:
name: Linting with Vale
runs-on: ubuntu-latest
permissions:
actions: read
checks: read
contents: read
pull-requests: read
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Vale Linter
uses: errata-ai/vale-action@reviewdog
with:
fail_on_error: false
vale_flags: "--no-exit --config=docs/.vale/vale.ini"
filter_mode: diff_context
files: docs/src/main/asciidoc/
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}