Skip to content

Commit

Permalink
Merge pull request #987 from imageworks/cspell-workflow
Browse files Browse the repository at this point in the history
Add github workflow to run spellcheck
  • Loading branch information
jrray authored Feb 26, 2024
2 parents 092b4fa + 0b18c86 commit 5a53f60
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 2 deletions.
12 changes: 12 additions & 0 deletions .github/workflows/cspell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Spellcheck

on:
pull_request:
push:

jobs:
spellcheck:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: streetsidesoftware/cspell-action@v5
3 changes: 3 additions & 0 deletions cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,7 @@
"filesequence",
"filesystems",
"filesytem",
"flatbuffers",
"flifetime",
"fowner",
"freetype",
Expand Down Expand Up @@ -617,6 +618,7 @@
"repr",
"reqby",
"reqs",
"respecifying",
"retpoline",
"retryable",
"rhelversion",
Expand Down Expand Up @@ -706,6 +708,7 @@
"tempfile",
"tempfs",
"templating",
"tera",
"testcase",
"testname",
"testpackage",
Expand Down
4 changes: 2 additions & 2 deletions docs/use/spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -476,9 +476,9 @@ requirements:
- pkg: imath
```

The `base:` field indicates which platform this platform spec is based on (inherits the requiremented from).
The `base:` field indicates which platform this platform spec is based on (inherits the requirements from).

Specifying a requirement drectly with `- ` is the same as specifying it with `add:`, but is a shorthand for convienence.
Specifying a requirement directly with `- ` is the same as specifying it with `add:`, but is a shorthand for convenience.

The `add:` and `remove:` entries indicate changes to the requirements inherited from the base platform. `add:` means "add or replace". `remove:` means remove entirely. `remove:` will work on components of packages, if they are specified, as well as full packages. Removing requirement is done before adding when determining the platform's final requirements.

Expand Down

0 comments on commit 5a53f60

Please sign in to comment.