File tree Expand file tree Collapse file tree 4 files changed +2
-65
lines changed Expand file tree Collapse file tree 4 files changed +2
-65
lines changed Load Diff This file was deleted.
Original file line number Diff line number Diff line change @@ -14,12 +14,6 @@ markdown-check-fix:
1414
1515 DO ./earthly/mdlint+MDLINT_LOCALLY --src = $(echo ${PWD }) --fix = --fix
1616
17- # spell-check Check spelling in this repo locally.
18- spell-check :
19- LOCALLY
20-
21- DO ./earthly/cspell+CSPELL_LOCALLY --src = $(echo ${PWD })
22-
2317# check-spelling Check spelling in this repo inside a container.
2418check-spelling :
2519 DO ./earthly/cspell+CHECK
Original file line number Diff line number Diff line change @@ -19,23 +19,11 @@ In an Earthfile in your repo, add the following:
1919
2020``` earthfile
2121check-spelling:
22- DO github.com/input-output-hk/catalyst-ci/earthly/cspell:<tag>+check-spelling
22+ DO github.com/input-output-hk/catalyst-ci/earthly/cspell:<tag>+CHECK
2323```
2424
2525Executing ` earthly +check-spelling ` will automatically run the spell checking to all files in the repository.
2626
27- ### Run locally
28-
29- ``` earthfile
30- spellcheck-lint:
31- # Check spelling in this repo.
32- LOCALLY
33-
34- DO github.com/input-output-hk/catalyst-ci/earthly/cspell:t1.2.0+CSPELL_LOCALLY --src=$(echo ${PWD})
35- ```
36-
37- In this use case, the UDC is run Locally, so that the src in the repo can be directly checked.
38-
3927## Configuration
4028
4129Each repo will need a [ ` cspell.json ` ] ( https://cspell.org/configuration/ ) file in the root of the repo.
Original file line number Diff line number Diff line change 11# cspell UDCs and Containers.
22VERSION 0.7
33
4- CSPELL_LOCALLY :
5- # DO NOT RUN THIS UDC INSIDE CONTAINER BUILDS.
6- # IT IS NOT FOR CONTAINER BUILDS.
7- # See: https://github.com/earthly/earthly/issues/580
8-
9- # Spell checking all docs and code is done with cspell
10- # See: cspell.org
11- COMMAND
12-
13- # Where we want to run the `lint` from.
14- ARG --required src
15-
16- # Unlikely to need to change this.
17- ARG cfg_file= cspell.json
18-
19- RUN echo Spell Checking Recursively from: $src
20-
21- RUN docker run \
22- --rm \
23- -v $src :/workdir \
24- ghcr.io/streetsidesoftware/cspell:8.0.0 \
25- lint . --dot
26-
274CHECK :
285 # Spell checking all docs and code is done with cspell
296 # See: cspell.org
4421
4522# A Test and example invocation of the above UDC.
4623cspell-test :
47- # As notes above, this check must only be run locally.
48- LOCALLY
4924 # Run with `earthly -P +cspell-test`
50- DO +CSPELL_LOCALLY --src = $(echo ${PWD }/../../)
25+ DO +CHECK --src = $(echo ${PWD }/../../)
5126
You can’t perform that action at this time.
0 commit comments