diff --git a/.github/workflows/compile_examples.yml b/.github/workflows/compile_examples.yml index f7e833d..d44bd97 100644 --- a/.github/workflows/compile_examples.yml +++ b/.github/workflows/compile_examples.yml @@ -1,4 +1,4 @@ -name: Compile examples folder +name: Compile Examples on: - push diff --git a/.github/workflows/spell_checker.yml b/.github/workflows/spell_checker.yml new file mode 100644 index 0000000..6e49bc9 --- /dev/null +++ b/.github/workflows/spell_checker.yml @@ -0,0 +1,24 @@ +name: Spell Check + +on: + pull_request: + push: + schedule: + # Run every Saturday at 3 AM UTC to catch new misspelling detections resulting from dictionary updates. + - cron: "0 3 * * 6" + # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#workflow_dispatch + workflow_dispatch: + # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#repository_dispatch + repository_dispatch: + +jobs: + spellcheck: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + # See: https://github.com/codespell-project/actions-codespell/blob/master/README.md + - name: Spell check + uses: codespell-project/actions-codespell@master diff --git a/README.md b/README.md index ffa5a76..cf7062c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ # DS3231-RTC Library +![](https://github.com/hasenradball/DS3231-RTC/actions/workflows/spell_checker.yml/badge.svg) +![](https://github.com/hasenradball/DS3231-RTC/actions/workflows/compile_examples.yml/badge.svg) + The **great** C++ Library for the DS3231 real-time clock (RTC) module. ## Description