diff --git a/README.md b/README.md index 54df0797..dc854fc3 100644 --- a/README.md +++ b/README.md @@ -244,7 +244,7 @@ Ensure your configuration is always in sync before every commit. Add this to you ```yaml - repo: https://github.com/Kilo59/ruff-sync - rev: v0.1.2 # Use the latest version + rev: v0.1.3 # Use the latest version hooks: - id: ruff-sync-check ``` diff --git a/docs/assets/github-pr-annotation.png b/docs/assets/github-pr-annotation.png new file mode 100644 index 00000000..d99eb0f6 Binary files /dev/null and b/docs/assets/github-pr-annotation.png differ diff --git a/docs/ci-integration.md b/docs/ci-integration.md index c934a14f..6dbab638 100644 --- a/docs/ci-integration.md +++ b/docs/ci-integration.md @@ -31,6 +31,8 @@ jobs: By using `--output-format github`, `ruff-sync` will emit special workflow commands that GitHub translates into inline annotations directly on your Pull Request's file diff. +![GitHub PR Annotation](assets/github-pr-annotation.png) + ### Automated Sync PRs Instead of just checking, you can have a bot automatically open a PR when the upstream configuration changes. diff --git a/docs/pre-defined-configs.md b/docs/pre-defined-configs.md index 82ed911c..95afd327 100644 --- a/docs/pre-defined-configs.md +++ b/docs/pre-defined-configs.md @@ -39,7 +39,7 @@ An exhaustive configuration that explicitly enables and documents almost all ava ```bash # Pin to a specific tag or branch - ruff-sync https://github.com/Kilo59/ruff-sync --branch v0.1.2 --path configs/kitchen-sink + ruff-sync https://github.com/Kilo59/ruff-sync --branch v0.1.3 --path configs/kitchen-sink ``` --- @@ -77,7 +77,7 @@ Tailored specifically for modern, asynchronous web applications. It focuses on p ```bash # Pin to a specific tag or branch - ruff-sync https://github.com/Kilo59/ruff-sync --branch v0.1.2 --path configs/fastapi + ruff-sync https://github.com/Kilo59/ruff-sync --branch v0.1.3 --path configs/fastapi ``` --- @@ -115,7 +115,7 @@ Optimized for data science workflows, focusing on readability and common pattern ```bash # Pin to a specific tag or branch - ruff-sync https://github.com/Kilo59/ruff-sync --branch v0.1.2 --path configs/data-science-engineering + ruff-sync https://github.com/Kilo59/ruff-sync --branch v0.1.3 --path configs/data-science-engineering ``` --- @@ -128,7 +128,7 @@ You can set your preferred curated configuration as the default in your `pyproje [tool.ruff-sync] upstream = "https://github.com/Kilo59/ruff-sync" path = "configs/fastapi" -branch = "main" # or "v0.1.2" to pin to a specific git tag +branch = "main" # or "v0.1.3" to pin to a specific git tag ``` --- diff --git a/pyproject.toml b/pyproject.toml index dfb1b241..ef9b3de1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "ruff-sync" -version = "0.1.3.dev3" +version = "0.1.3" description = "Synchronize Ruff linter configuration across projects" keywords = ["ruff", "linter", "config", "synchronize", "python", "linting", "automation", "tomlkit", "pre-commit"] authors = [ diff --git a/src/ruff_sync/core.py b/src/ruff_sync/core.py index fd286efa..0185822d 100644 --- a/src/ruff_sync/core.py +++ b/src/ruff_sync/core.py @@ -974,7 +974,7 @@ async def check( except ValueError: rel_path = _source_toml_path fmt.error( - f"❌ Ruff configuration at {rel_path} is out of sync!", + f"❌ Ruff configuration at {rel_path} is out of sync! Run `ruff-sync` to update.", file_path=rel_path, logger=LOGGER, ) diff --git a/uv.lock b/uv.lock index 835d4844..ac15df26 100644 --- a/uv.lock +++ b/uv.lock @@ -1484,7 +1484,7 @@ wheels = [ [[package]] name = "ruff-sync" -version = "0.1.3.dev3" +version = "0.1.3" source = { editable = "." } dependencies = [ { name = "httpx" },