Skip to content

Commit

Permalink
Added language and misspell check for markdown files (#439)
Browse files Browse the repository at this point in the history
* spellcheck added and lang tool fixes
  • Loading branch information
yo-404 authored Jan 18, 2024
1 parent afe91eb commit fee1db3
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 4 deletions.
43 changes: 43 additions & 0 deletions .github/workflows/spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Spellcheck
on:
push:
# branches: [main]
pull_request:
jobs:
spell-check:
name: Language tool & Misspell check
runs-on: ubuntu-latest
steps:
- name: check out code
uses: actions/checkout@v3
- name: running language tool
uses: reviewdog/action-languagetool@v1
with:
github_token: ${{ secrets.github_token }}
# Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review].
reporter: github-check
# Change reporter level if you need.
level: warning
language: en-US
disabled_categories: 'TYPOS,TYPOGRAPHY,CASING'
disabled_rules: 'WHITESPACE_RULE,EN_QUOTES,DASH_RULE,WORD_CONTAINS_UNDERSCORE,UPPERCASE_SENTENCE_START,ARROWS,COMMA_PARENTHESIS_WHITESPACE,UNLIKELY_OPENING_PUNCTUATION,SENTENCE_WHITESPACE,CURRENCY,EN_UNPAIRED_BRACKETS,PHRASE_REPETITION,PUNCTUATION_PARAGRAPH_END,METRIC_UNITS_EN_US,ENGLISH_WORD_REPEAT_BEGINNING_RULE,DOUBLE_PUNCTUATION,'
enabled_only: 'false'
enabled_rules: ''
enabled_categories: ''
patterns: "**.md"



- name: running misspell
# To perform misspell check even after the language tool test fails
if: success() || failure()
uses: reviewdog/action-misspell@v1
with:
github_token: ${{ secrets.github_token }}
locale: "US"
reporter: github-check
level: info
pattern: "**.md"
exclude: |
./.git/*
./.cache/*
2 changes: 1 addition & 1 deletion INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ $ sudo ninja -C build install

This will install Clevis to a location determined at configure time.

See the output of `meson --help` for the available options. Typically
See the output of `meson --help` for the available options. Typically,
much won't be needed besides providing an alternative --prefix option at
configure time, and maybe DESTDIR at install time if you're packaging for
a distro.
Expand Down
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,7 @@ advertisement is trusted.

Clevis provides support to encrypt a key in a Trusted Platform Module 2.0 (TPM2)
chip. The cryptographically-strong, random key used for encryption is encrypted
using the TPM2 chip, and then at decryption time is decrypted using the TPM2 to
allow clevis to decrypt the secret stored in the JWE.
using the TPM2 chip, and is decrypted using TPM2 at the time of decryption to allow clevis to decrypt the secret stored in the JWE.

For example:

Expand Down Expand Up @@ -164,7 +163,7 @@ initramfs you will need to run:
sudo update-initramfs -u -k 'all'
```

Upon reboot it will behave exactly as if using Dracut.
Upon reboot, it will behave exactly as if using Dracut.

#### Unlocker: UDisks2

Expand Down

0 comments on commit fee1db3

Please sign in to comment.