Skip to content

Commit

Permalink
Add spelling check to GitHub workflow (MagicMirrorOrg#3623)
Browse files Browse the repository at this point in the history
Besides updating cspell and handling spelling issues, the important
change is adding the spelling check to the GitHub workflow.

I'm not sure if it will bother us too much when people create PRs. But I
wanted to give it a try. Or do you have any other ideas on how we can
run the spelling check on a regular basis?
  • Loading branch information
KristjanESPERANTO authored Nov 3, 2024
1 parent 0aae771 commit 6ce3622
Show file tree
Hide file tree
Showing 5 changed files with 154 additions and 113 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/spellcheck.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# This workflow will run a spellcheck on the codebase.
# It runs a few days before each release. At 00:00 on day-of-month 27 in March, June, September, and December.

name: Run Spellcheck

on:
schedule:
- cron: "0 0 27 3,6,9,12 *"

permissions:
contents: read

jobs:
spellcheck:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
ref: develop
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: "22"
check-latest: true
cache: "npm"
- name: Install dependencies
run: |
npm run install-mm:dev
- name: Run Spellcheck
run: npm run test:spellcheck
7 changes: 4 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ _This release is scheduled to be released on 2025-01-01._
- [core] Add wayland and windows start options to `package.json` (#3594)
- [linter] re-added `eslint-plugin-import`now that it supports ESLint v9 (#3586)
- [docs] Added step for npm publishing in release process (#3595)
- [core] Add GitHub workflow to run spellcheck a few days before each release.

### Removed

Expand All @@ -30,9 +31,9 @@ _This release is scheduled to be released on 2025-01-01._

- [updatenotification] Fix pm2 using detection when pm2 script is inside or outside MagicMirror root folder (#3576) (#3605)
- [core] Fix loading node_helper of modules: avoid black screen, display errors and continue loading with next module (#3578)
- [weather] changed default value for weatherEndpoint of provider openweathermap to "/onecall" (#3574)
- [tests] fix electron tests with mock dates, the mock on server side was missing (#3597)
- [tests] fix testcases with hard coded Date.now (#3597)
- [weather] Changed default value for weatherEndpoint of provider openweathermap to "/onecall" (#3574)
- [tests] Fix electron tests with mock dates, the mock on server side was missing (#3597)
- [tests] Fix test cases with hard coded Date.now (#3597)
- [core] Fix missing `basePath` where `location.host` is used (#3613)

## [2.29.0] - 2024-10-01
Expand Down
9 changes: 9 additions & 0 deletions cspell.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
"currentweather",
"CUSTOMCSS",
"customregions",
"cxmj",
"Cymraeg",
"dariom",
"darksky",
Expand All @@ -48,6 +49,8 @@
"DAYBEFOREYESTERDAY",
"defaultmodules",
"dgoth",
"dkallen",
"drivelist",
"DTEND",
"Duffman",
"earlman",
Expand Down Expand Up @@ -79,6 +82,7 @@
"fullday",
"fullscreen",
"Gevoelstemperatuur",
"GHSA",
"ghsas",
"grenagit",
"Hirschberger",
Expand All @@ -92,6 +96,7 @@
"jakemulley",
"jakobsarwary",
"jalibu",
"jargordon",
"jetson",
"jkriegshauser",
"jsdocs",
Expand All @@ -112,8 +117,10 @@
"krekos",
"Kristjan",
"krukle",
"Landis",
"larryare",
"letsencrypt",
"libgpiod",
"Lightspeed",
"locationforecast",
"lockstring",
Expand Down Expand Up @@ -162,6 +169,7 @@
"psieg",
"radokristof",
"rajniszp",
"rebuilded",
"Reis",
"rejas",
"Resig",
Expand All @@ -172,6 +180,7 @@
"sdetweil",
"sendheaders",
"serveronly",
"skpanagiotis",
"SMHI",
"Snille",
"socketclient",
Expand Down
Loading

0 comments on commit 6ce3622

Please sign in to comment.