From b3b27e0903c03b2f516f2068fe89e42333e9ad38 Mon Sep 17 00:00:00 2001 From: Jeremy Felder Date: Sun, 21 Jan 2024 13:32:47 +0200 Subject: [PATCH] Add codespell for docs directory --- .codespellignore | 1 + .github/workflows/codespell.yml | 18 ++++++++++++++++++ docs/icicle/colab-instructions.md | 2 +- 3 files changed, 20 insertions(+), 1 deletion(-) create mode 100644 .codespellignore create mode 100644 .github/workflows/codespell.yml diff --git a/.codespellignore b/.codespellignore new file mode 100644 index 0000000..4761154 --- /dev/null +++ b/.codespellignore @@ -0,0 +1 @@ +ICICLE diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 0000000..509e0b0 --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,18 @@ +name: Check Spelling + +on: + pull_request: + branches: + - main + +jobs: + spelling-checker: + name: Check Spelling + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: codespell-project/actions-codespell@v2 + with: + path: docs + # https://github.com/codespell-project/actions-codespell?tab=readme-ov-file#parameter-ignore_words_file + ignore_words_file: .codespellignore \ No newline at end of file diff --git a/docs/icicle/colab-instructions.md b/docs/icicle/colab-instructions.md index 0ed1168..e55e7b8 100644 --- a/docs/icicle/colab-instructions.md +++ b/docs/icicle/colab-instructions.md @@ -82,7 +82,7 @@ Wed Jan 17 13:10:18 2024 +---------------------------------------------------------------------------------------+ ``` -## Clonig ICICLE and running test +## Cloning ICICLE and running test Now we are ready to clone ICICE repository,