diff --git a/.github/README.md b/.github/README.md index 592a997..dd1b175 100644 --- a/.github/README.md +++ b/.github/README.md @@ -58,10 +58,18 @@ pipx install "$(ls dist/*.whl | head -n 1)" Install a published release artifact with `pipx`: ```bash -pipx install https://github.com/Splinter3D/StyleCheck/releases/download/vX.Y.Z/splinter3d_style-X.Y.Z-py3-none-any.whl +pipx install git+https://github.com/Splinter3D/StyleCheck splinter3d_style ``` +## Update From A Release + +Update a the package with pipx + +```bash +pipx upgrade splinter3d_style +``` + ## Use With pre-commit Add this repository and a release tag to your `.pre-commit-config.yaml`: diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1cc4a04..13f8894 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -23,7 +23,7 @@ repos: hooks: - id: check_versions name: check_versions - entry: bash -c 'scripts/check_versions.sh' + entry: bash -c 'scripts/check-versions.sh' language: system pass_filenames: false always_run: true @@ -33,3 +33,9 @@ repos: language: system pass_filenames: false always_run: true + - id: splinter3d-style + name: splinter3d-style + entry: bash -c 'poetry run splinter3d_style' + language: system + pass_filenames: false + always_run: true diff --git a/scripts/bootstrap-pre-commit.sh b/scripts/bootstrap-pre-commit.sh index 4c45f84..13a589f 100755 --- a/scripts/bootstrap-pre-commit.sh +++ b/scripts/bootstrap-pre-commit.sh @@ -4,6 +4,5 @@ if ! command -v pre-commit &> /dev/null; then python3 -m pip install --user pre-commit || echo "Could not install pre-commit. Please install it with your package manager." && exit 1 fi pre-commit install -pre-commit install --hook-type pre-push || true pre-commit run --all-files || true echo "pre-commit hooks installed."