Skip to content

Commit 6ce3622

Browse files
Add spelling check to GitHub workflow (#3623)
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?
1 parent 0aae771 commit 6ce3622

File tree

5 files changed

+154
-113
lines changed

5 files changed

+154
-113
lines changed

.github/workflows/spellcheck.yaml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# This workflow will run a spellcheck on the codebase.
2+
# It runs a few days before each release. At 00:00 on day-of-month 27 in March, June, September, and December.
3+
4+
name: Run Spellcheck
5+
6+
on:
7+
schedule:
8+
- cron: "0 0 27 3,6,9,12 *"
9+
10+
permissions:
11+
contents: read
12+
13+
jobs:
14+
spellcheck:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Checkout code
18+
uses: actions/checkout@v4
19+
with:
20+
ref: develop
21+
- name: Set up Node.js
22+
uses: actions/setup-node@v4
23+
with:
24+
node-version: "22"
25+
check-latest: true
26+
cache: "npm"
27+
- name: Install dependencies
28+
run: |
29+
npm run install-mm:dev
30+
- name: Run Spellcheck
31+
run: npm run test:spellcheck

CHANGELOG.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ _This release is scheduled to be released on 2025-01-01._
1414
- [core] Add wayland and windows start options to `package.json` (#3594)
1515
- [linter] re-added `eslint-plugin-import`now that it supports ESLint v9 (#3586)
1616
- [docs] Added step for npm publishing in release process (#3595)
17+
- [core] Add GitHub workflow to run spellcheck a few days before each release.
1718

1819
### Removed
1920

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

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

3839
## [2.29.0] - 2024-10-01

cspell.config.json

+9
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
"currentweather",
3939
"CUSTOMCSS",
4040
"customregions",
41+
"cxmj",
4142
"Cymraeg",
4243
"dariom",
4344
"darksky",
@@ -48,6 +49,8 @@
4849
"DAYBEFOREYESTERDAY",
4950
"defaultmodules",
5051
"dgoth",
52+
"dkallen",
53+
"drivelist",
5154
"DTEND",
5255
"Duffman",
5356
"earlman",
@@ -79,6 +82,7 @@
7982
"fullday",
8083
"fullscreen",
8184
"Gevoelstemperatuur",
85+
"GHSA",
8286
"ghsas",
8387
"grenagit",
8488
"Hirschberger",
@@ -92,6 +96,7 @@
9296
"jakemulley",
9397
"jakobsarwary",
9498
"jalibu",
99+
"jargordon",
95100
"jetson",
96101
"jkriegshauser",
97102
"jsdocs",
@@ -112,8 +117,10 @@
112117
"krekos",
113118
"Kristjan",
114119
"krukle",
120+
"Landis",
115121
"larryare",
116122
"letsencrypt",
123+
"libgpiod",
117124
"Lightspeed",
118125
"locationforecast",
119126
"lockstring",
@@ -162,6 +169,7 @@
162169
"psieg",
163170
"radokristof",
164171
"rajniszp",
172+
"rebuilded",
165173
"Reis",
166174
"rejas",
167175
"Resig",
@@ -172,6 +180,7 @@
172180
"sdetweil",
173181
"sendheaders",
174182
"serveronly",
183+
"skpanagiotis",
175184
"SMHI",
176185
"Snille",
177186
"socketclient",

0 commit comments

Comments
 (0)