diff --git a/.github/spelling/allow.txt b/.github/spelling/allow.txt new file mode 100644 index 000000000..069c428a2 --- /dev/null +++ b/.github/spelling/allow.txt @@ -0,0 +1,6 @@ +plugin +plugins +pluggability +png +lifecycle + diff --git a/.github/spelling/check-paths.txt b/.github/spelling/check-paths.txt new file mode 100644 index 000000000..1446b9dc4 --- /dev/null +++ b/.github/spelling/check-paths.txt @@ -0,0 +1,2 @@ +*.md:comment +*.go diff --git a/.github/spelling/excludes.txt b/.github/spelling/excludes.txt new file mode 100644 index 000000000..a2eb86d1d --- /dev/null +++ b/.github/spelling/excludes.txt @@ -0,0 +1,3 @@ +go.mod +go.sum +(?:^|/)deploy/ \ No newline at end of file diff --git a/.github/spelling/expect.txt b/.github/spelling/expect.txt new file mode 100644 index 000000000..844280a15 --- /dev/null +++ b/.github/spelling/expect.txt @@ -0,0 +1,7 @@ +GitHub +Markdown +golang +API +JSON +ioutil +ctx diff --git a/.github/spelling/filters.txt b/.github/spelling/filters.txt new file mode 100644 index 000000000..ea64cf44a --- /dev/null +++ b/.github/spelling/filters.txt @@ -0,0 +1 @@ +\.go$ -> ^\s*//.* # Only keep comments in Go files diff --git a/.github/spelling/patterns.txt b/.github/spelling/patterns.txt new file mode 100644 index 000000000..e69de29bb diff --git a/.github/workflows/spellcheck.yaml b/.github/workflows/spellcheck.yaml new file mode 100644 index 000000000..6ee667d48 --- /dev/null +++ b/.github/workflows/spellcheck.yaml @@ -0,0 +1,23 @@ +# .github/workflows/spellcheck.yml +name: Spell Check PR + +on: + pull_request: + paths: + - '**/*.go' + - '**/*.md' + - '.github/spelling/**' + +jobs: + check-spelling: + runs-on: ubuntu-latest + permissions: + contents: read + pull-requests: write + steps: + - uses: actions/checkout@v4 + + - name: Spell Check + uses: check-spelling/check-spelling@v0.0.25 + with: + config: .github/spelling