diff --git a/.github/workflows/spelling-incremental.yml b/.github/workflows/spelling-incremental.yml new file mode 100644 index 0000000..320589a --- /dev/null +++ b/.github/workflows/spelling-incremental.yml @@ -0,0 +1,28 @@ +name: Spellcheck(Incremental) + +on: + pull_request: + branches: + - '**' + workflow_dispatch: + +jobs: + spelling: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - name: Get all changed markdown files + uses: tj-actions/changed-files@v45 + id: changed_files + with: + files: | + **.md + + - name: Run Spellcheck + id: spellcheck + uses: rojopolis/spellcheck-github-actions@v0 + with: + task_name: Markdown + source_files: ${{ steps.changed_files.outputs.all_changed_files }} + config_path: .spellcheck.yml diff --git a/.spellcheck.yml b/.spellcheck.yml new file mode 100644 index 0000000..33142a5 --- /dev/null +++ b/.spellcheck.yml @@ -0,0 +1,17 @@ +matrix: +- name: Markdown + sources: + - '**/*.md' + expect_match: false # false -> supress errors if no markdown files were edited + aspell: + lang: en + dictionary: + wordlists: + - .wordlist.txt + encoding: utf-8 + pipeline: + - pyspelling.filters.markdown + - pyspelling.filters.text + default_encoding: utf-8 + suggest: true + diff --git a/.wordlist.txt b/.wordlist.txt new file mode 100644 index 0000000..4d6c057 --- /dev/null +++ b/.wordlist.txt @@ -0,0 +1,23 @@ +ALLOC +IANA +SHARDING +WAKU +Waku +danielkaiser +creativecommons +github +GITHUB +https +iana +md +rfc +RFC +www +DHT +DoS +GossipSub +gossipsub +libp2p +pubsub +subnets +ZXCV \ No newline at end of file