Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
Binary file added docs/assets/github-pr-annotation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/ci-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
8 changes: 4 additions & 4 deletions docs/pre-defined-configs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

---
Expand Down Expand Up @@ -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
```

---
Expand Down Expand Up @@ -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
```

---
Expand All @@ -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
```

---
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -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 = [
Expand Down
2 changes: 1 addition & 1 deletion src/ruff_sync/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
)
Expand Down
2 changes: 1 addition & 1 deletion uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading