Skip to content

Commit

Permalink
ci: add markdownlint, misspell and languagetool
Browse files Browse the repository at this point in the history
JIRA: CI-94
  • Loading branch information
nalajcie committed Jun 15, 2023
1 parent 7dc8b37 commit 2b3f485
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 0 deletions.
41 changes: 41 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# vim:sw=2:ts=2
# static linters which can be run in a single repo (do not need phoenix-rtos-project)
name: lint

# on events
on:
pull_request:
branches:
- master
- 'feature/*'

jobs:
markdownlint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: reviewdog/action-markdownlint@v0
with:
github_token: ${{ secrets.github_token }}
reporter: github-pr-review
fail_on_error: true

misspell:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: reviewdog/action-misspell@v1
with:
github_token: ${{ secrets.github_token }}
reporter: github-pr-review
fail_on_error: true


languagetool:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: reviewdog/action-languagetool@v1
with:
github_token: ${{ secrets.github_token }}
reporter: github-pr-review
36 changes: 36 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Example markdownlint configuration with all properties set to their default value

# Default state for all rules
default: true

# Path to configuration file to extend
extends: null

# MD010/no-hard-tabs - Hard tabs
MD010:
# Include code blocks
code_blocks: false
# Fenced code languages to ignore
ignore_code_languages: []
# Number of spaces for each hard tab
spaces_per_tab: 4

# MD013/line-length - Line length
MD013:
# Number of characters
line_length: 120
# Number of characters for headings
heading_line_length: 120
# Number of characters for code blocks
code_block_line_length: 120
# Include code blocks
code_blocks: false
# Strict length checking
strict: false
# Stern length checking
stern: true

# MD033/no-inline-html - Inline HTML
MD033:
# Allowed elements
allowed_elements: [img]

0 comments on commit 2b3f485

Please sign in to comment.