diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 0000000000..99b3dec599 --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,19 @@ +--- +name: Codespell + +on: + push: + branches: [main] + pull_request: + branches: [main] + +jobs: + codespell: + name: Check for spelling errors + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Codespell + uses: codespell-project/actions-codespell@v2 diff --git a/docs/help.md b/docs/help.md index 6e5fe581f7..a6020b19cc 100644 --- a/docs/help.md +++ b/docs/help.md @@ -147,7 +147,7 @@ Here's what to have in mind and how to review a pull request: * Don't worry too much about things like commit message styles, I will squash and merge customizing the commit manually. -* Also don't worry about style rules, there are already automatized tools checking that. +* Also don't worry about style rules, there are already automated tools checking that. And if there's any other style or consistency need, I'll ask directly for that, or I'll add commits on top with the needed changes. diff --git a/docs/release-notes.md b/docs/release-notes.md index 42ddaed39a..e2eb6543f3 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -579,7 +579,7 @@ * ⬆️ Upgrade Ruff and Black. PR [#968](https://github.com/tiangolo/sqlmodel/pull/968) by [@tiangolo](https://github.com/tiangolo). * ⬆ Bump tiangolo/issue-manager from 0.4.1 to 0.5.0. PR [#922](https://github.com/tiangolo/sqlmodel/pull/922) by [@dependabot[bot]](https://github.com/apps/dependabot). -* 📌 Pin typing-extensions in tests for compatiblity with Python 3.8, dirty-equals, Pydantic. PR [#965](https://github.com/tiangolo/sqlmodel/pull/965) by [@tiangolo](https://github.com/tiangolo). +* 📌 Pin typing-extensions in tests for compatibility with Python 3.8, dirty-equals, Pydantic. PR [#965](https://github.com/tiangolo/sqlmodel/pull/965) by [@tiangolo](https://github.com/tiangolo). * 👷 Update GitHub Actions to download and upload artifacts. PR [#936](https://github.com/tiangolo/sqlmodel/pull/936) by [@tiangolo](https://github.com/tiangolo). * 👷 Tweak CI for test-redistribute, add needed env vars for slim. PR [#929](https://github.com/tiangolo/sqlmodel/pull/929) by [@tiangolo](https://github.com/tiangolo). @@ -793,7 +793,7 @@ In the future SQLModel will include the standard default recommended packages, a ### Fixes * 🐛 Fix auto detecting and setting `nullable`, allowing overrides in field. PR [#423](https://github.com/tiangolo/sqlmodel/pull/423) by [@JonasKs](https://github.com/JonasKs) and [@br-follow](https://github.com/br-follow). -* ♻️ Update `expresion.py`, sync from Jinja2 template, implement `inherit_cache` to solve errors like: `SAWarning: Class SelectOfScalar will not make use of SQL compilation caching`. PR [#422](https://github.com/tiangolo/sqlmodel/pull/422) by [@tiangolo](https://github.com/tiangolo). +* ♻️ Update `expression.py`, sync from Jinja2 template, implement `inherit_cache` to solve errors like: `SAWarning: Class SelectOfScalar will not make use of SQL compilation caching`. PR [#422](https://github.com/tiangolo/sqlmodel/pull/422) by [@tiangolo](https://github.com/tiangolo). ### Docs diff --git a/pyproject.toml b/pyproject.toml index bbdfe801ed..8f3838780f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -152,6 +152,11 @@ known-third-party = ["sqlmodel", "sqlalchemy", "pydantic", "fastapi"] # Preserve types, even if a file imports `from __future__ import annotations`. keep-runtime-typing = true +[tool.codespell] +skip = '.git,*.pdf,*.svg,*.drawio' +# Ines - name +ignore-words-list = 'ines,re-use,selectin,alls' + [tool.ty.terminal] error-on-warning = true