PHP_CodeSniffer-documentation/.github/workflows/basic-qa.yml at a9a1c5c5e9ced093c8d62d03a8b7c79f6aa891d2 · PHPCSStandards/PHP_CodeSniffer-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
89
90
91
92
93
94
95
96
97
name: CS

on:
  # Run on all pushes and on all pull requests.
  push:
  pull_request:
  # Allow manually triggering the workflow.
  workflow_dispatch:

# Do NOT cancels all previous workflow runs for the same branch that have not yet completed.
concurrency:
  # The concurrency group contains the workflow name and the branch name.
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: false

jobs:
  markdownlint:
    name: 'Lint Markdown'
    uses: PHPCSStandards/.github/.github/workflows/reusable-markdownlint.yml@main

  yamllint:
    name: 'Lint Yaml'
    uses: PHPCSStandards/.github/.github/workflows/reusable-yamllint.yml@main
    with:
      strict: true

  linkcheck:
    name: "Check links"
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Restore lychee cache
        uses: actions/cache@v4
        with:
          path: .lycheecache
          key: cache-lychee-${{ github.sha }}
          restore-keys: cache-lychee-

      - name: Link Checker
        uses: lycheeverse/lychee-action@v2
        with:
          args: --cache --max-cache-age 1w --verbose './**/*.md'
          format: markdown
          token: ${{ secrets.GITHUB_TOKEN }}
          fail: true

  spellcheck:
    name: Spellcheck
    # Config file: .cspell.yml

    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Spellcheck
        id: spellcheck
        uses: streetsidesoftware/cspell-action@v7
        with:
          # Define glob patterns to filter the files to be checked. Use a new line between patterns to define multiple patterns.
          files: '**/*.md'
          root: '.'
          suggestions: true
          # Notification level for annotations. Allowed values are: warning, error, none
          inline: warning
          treat_flagged_words_as_errors: true
          # Determines if the action should be failed if any spelling issues are found.
          strict: false
          # Limit the files checked to the ones in the pull request or push.
          incremental_files_only: false

      - name: Fail the build when more spelling issues were found than expected
        # yamllint disable-line rule:line-length
        if: ${{ steps.spellcheck.outputs.success == false && steps.spellcheck.outputs.number_of_issues != 11  && steps.spellcheck.outputs.number_of_files_with_issues != 5}}
        run: exit 1

  shellcheck:
    name: 'ShellCheck'
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Set up problem matcher
        uses: lumaxis/shellcheck-problem-matchers@v2
        with:
          format: gcc

      - name: Run ShellCheck
        uses: ludeeus/action-shellcheck@2.0.0
        with:
          format: gcc