1
0
Fork 0
mirror of https://github.com/corona-warn-app/cwa-documentation synced 2025-07-04 12:28:35 +02:00

feat: Use makefile targets for document linting (#215)

This Makefile provides several targets for linting
documents. It utilizes several npm packages.
Functionality includes:

* Spellcheck
* Linting of markdown
* Check for broken links
* Sorting of dictionary file
* Detect inconsidered language

All targets (excluding the sorting of the dict file) are part
of the Github Action pipeline and will fail if quality
standards are not met.

Signed-off-by: Johannes Amorosa <johannes.amorosa@endocode.com>
This commit is contained in:
Johannes Amorosa 2020-07-05 15:37:23 +02:00 committed by GitHub
parent f44275d4b1
commit 02caed10d1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 4073 additions and 47 deletions

40
.github/workflows/checks.yml vendored Normal file
View file

@ -0,0 +1,40 @@
name: Checks
on: [push]
jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: Install requirements
run: |
sudo apt install -y automake npm nodejs
- name: Checkout code
uses: actions/checkout@v2
- name: Install npm dependencies
if: always()
run: |
make install
- name: Linting markdown
if: always()
run: |
make markdownlint
- name: Checking for broken links
if: always()
run: |
make checklinks
- name: Spellchecking english
if: always()
run: |
make spellcheck-en
- name: Detect inconsiderate language
if: always()
run: |
make detect-inconsiderate-language