diff --git a/.cspell.json b/.cspell.json new file mode 100644 index 0000000..b8eb377 --- /dev/null +++ b/.cspell.json @@ -0,0 +1,15 @@ +{ + "version": "0.2", + "language": "en", + "dictionaries": ["en-gb", "companies", "softwareTerms", "misc", "python", "bash", "filetypes"], + "words": [ + "Kenney", + "commandline", + "pyproject", + "pydantic", + "pipx" + ], + "ignorePaths": [ + ".gitignore" + ] +} diff --git a/.github/dependabot.yml b/.github/dependabot.yml index b5b392c..ae6e492 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -2,10 +2,10 @@ # package ecosystems to update and where the package manifests are located. # Please see the documentation for all configuration options: # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates - +--- version: 2 updates: - - package-ecosystem: "poetry" # See documentation for possible values + - package-ecosystem: "pip" # See documentation for possible values directory: "/" # Location of package manifests schedule: interval: "weekly" diff --git a/.github/workflows/build-and-publish.yml b/.github/workflows/build-and-publish.yml index 024dc7c..240b9e8 100644 --- a/.github/workflows/build-and-publish.yml +++ b/.github/workflows/build-and-publish.yml @@ -1,3 +1,5 @@ +--- +# cspell: ignore marvinpinto, pypa name: Build and publish on: @@ -34,12 +36,15 @@ jobs: - run: poetry install - - run: PKG_VERSION=$(poetry version --short) && echo $PKG_VERSION && echo "value=$PKG_VERSION" >> $GITHUB_OUTPUT + - run: | + PKG_VERSION=$(poetry version --short) && \ + echo "$PKG_VERSION" && \ + echo "value=$PKG_VERSION" >> "$GITHUB_OUTPUT" id: pkg_version - run: poetry build - - - run: echo "value=$(ls dist/*.tar.gz | sed 's/.tar.gz//' | xargs basename)" >> $GITHUB_OUTPUT + # shellcheck disable=SC2012 + - run: echo "value=$(ls dist/*.tar.gz | sed 's/.tar.gz//' | xargs basename)" >> "$GITHUB_OUTPUT" id: dist_folder - name: Publish distribution to GitHub @@ -54,4 +59,4 @@ jobs: uses: pypa/gh-action-pypi-publish@master with: user: __token__ - password: ${{ secrets.PYPI_API_TOKEN }} \ No newline at end of file + password: ${{ secrets.PYPI_API_TOKEN }} diff --git a/.github/workflows/install-package.yml b/.github/workflows/install-package.yml index 80b9c69..a0df3ca 100644 --- a/.github/workflows/install-package.yml +++ b/.github/workflows/install-package.yml @@ -1,3 +1,4 @@ +--- name: Install package on: @@ -38,4 +39,3 @@ jobs: - run: poetry install - run: poetry version - diff --git a/.github/workflows/on-pr-lint.yml b/.github/workflows/on-pr-lint.yml new file mode 100644 index 0000000..a5821fb --- /dev/null +++ b/.github/workflows/on-pr-lint.yml @@ -0,0 +1,16 @@ +--- +# cspell: ignore nvuillam + +name: Lint on Pull Request +on: + pull_request: + +jobs: + lint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + - uses: nvuillam/mega-linter@v6 + with: + PYTHON_MYPY_DISABLE_ERRORS: true diff --git a/README.md b/README.md index add9034..a0b0621 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ requests = { version = "^2.28.2", optional = true } # Package added as optional [tool.poetry.extras] #...existing extras... -web = ["requesets"] # A new extra 'web' +web = ["requests"] # A new extra 'web' ``` ### Build package diff --git a/coder_dojo_common/models.py b/coder_dojo_common/models.py index bf4e546..8449d92 100644 --- a/coder_dojo_common/models.py +++ b/coder_dojo_common/models.py @@ -5,7 +5,7 @@ import json from datetime import datetime, timedelta from pathlib import Path -from typing import Optional, Union, Iterator +from typing import Iterator, Optional, Union from pydantic import BaseModel from requests import Session diff --git a/coder_dojo_common/settings.py b/coder_dojo_common/settings.py index 703bdeb..337d96d 100644 --- a/coder_dojo_common/settings.py +++ b/coder_dojo_common/settings.py @@ -9,7 +9,7 @@ class CoderDojoSettings(BaseSettings): # Configuration class Config: """ - Set env prefix, root values can be overriden from environment variables prefixed with CODER_DOJO_ + Set env prefix, root values can be overridden from environment variables prefixed with CODER_DOJO_ e.g. CODER_DOJO_ROOT_DIR=/tmp