Skip to content

Commit

Permalink
Add CI workflows for markdown linting and spell checking
Browse files Browse the repository at this point in the history
  • Loading branch information
shaavan committed Oct 21, 2024
1 parent cc47d11 commit 5767994
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .github/workflows/markdown-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Markdown Lint

on:
push:
branches:
- main
pull_request:

jobs:
markdown-lint:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v2

- name: Set up Node.js environment
uses: actions/setup-node@v2
with:
node-version: '16' # Upgrade to Node.js version 16

- name: Install markdownlint-cli
run: npm install -g markdownlint-cli

- name: Run markdownlint on markdown files
run: markdownlint '**/*.md'
24 changes: 24 additions & 0 deletions .github/workflows/spell-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Spell Check

on:
push:
branches:
- main
pull_request:

jobs:
spell-check:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v2

- name: Install aspell
run: sudo apt-get install -y aspell aspell-en

- name: Install pyspelling
run: pip install pyspelling

- name: Run Spell Checker
run: pyspelling -c spellcheck.yaml
16 changes: 16 additions & 0 deletions spellcheck.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# spellcheck.yaml

matrix:
- name: Markdown Files
sources:
- '**/*.md' # Check all markdown files in the repository
dictionary:
# Use the default language dictionary (no need for a list of dictionaries)
language: en_US # Specify the language
# List of custom words to exclude (e.g., technical terms, proper names)
ignore_words:
- GitHub
- markdownlint
- pyspelling
- CI
- lint

0 comments on commit 5767994

Please sign in to comment.