foreman-documentation/.github/workflows/vale.yml at f5295eca1789fbdd3cfa78ad1718a9648e16c5b7 · theforeman/foreman-documentation · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
---
name: Vale
on:
  pull_request:
    paths:
      - 'guides/common/**.adoc'
      - '.github/workflows/vale.yml'
      - '.vale/**'
      - .vale.ini
      - .vale-dita.ini

jobs:
  lint-style:
    name: lint style
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout PR branch
        uses: actions/checkout@v7

      - name: Get changed files
        id: changed-files
        uses: tj-actions/changed-files@v47
        with:
          files: |
            guides/common/*.adoc
            guides/common/modules/*.adoc
          files_ignore: |
            guides/common/attributes*.adoc
            guides/common/header.adoc
            guides/common/ribbons.adoc
          json: true
          escape_json: false

      - name: List changed files
        run: |
          echo "Any files changed? ${{ steps.changed-files.outputs.any_changed }}"
          echo "Changed files list: ${{ steps.changed-files.outputs.all_changed_files }}"
          echo "Count: ${{ steps.changed-files.outputs.all_changed_files_count }}"

      - name: Install Asciidoctor
        if: steps.changed-files.outputs.any_changed == 'true'
        run: sudo apt-get install -y asciidoctor

      - name: Vale style lint
        if: steps.changed-files.outputs.any_changed == 'true'
        uses: errata-ai/vale-action@v2
        with:
          files: ${{ steps.changed-files.outputs.all_changed_files }}
          filter_mode: diff_context
          vale_flags: "--no-exit --minAlertLevel=error"
          reporter: github-pr-review
          fail_on_error: true

  lint-dita:
    name: lint DITA
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout PR branch
        uses: actions/checkout@v7

      - name: Get changed files
        id: changed-files
        uses: tj-actions/changed-files@v47
        with:
          files: |
            guides/common/modules/*.adoc
          json: true
          escape_json: false

      - name: List changed files
        run: |
          echo "Any files changed? ${{ steps.changed-files.outputs.any_changed }}"
          echo "Changed files list: ${{ steps.changed-files.outputs.all_changed_files }}"
          echo "Count: ${{ steps.changed-files.outputs.all_changed_files_count }}"

      - name: Install Asciidoctor
        if: steps.changed-files.outputs.any_changed == 'true'
        run: sudo apt-get install -y asciidoctor

      - name: Vale DITA lint
        if: steps.changed-files.outputs.any_changed == 'true'
        uses: errata-ai/vale-action@v2
        with:
          files: ${{ steps.changed-files.outputs.all_changed_files }}
          filter_mode: diff_context
          vale_flags: "--no-exit --minAlertLevel=warning --config=.vale-dita.ini"
          reporter: github-pr-review
          fail_on_error: true