Skip to content

Commit cdd3208

Browse files
committed
docs: Update CI example
1 parent a223128 commit cdd3208

1 file changed

Lines changed: 7 additions & 14 deletions

File tree

docs/guide/users/checking.md

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -107,22 +107,15 @@ jobs:
107107
check-api:
108108
runs-on: ubuntu-latest
109109
steps:
110-
- uses: actions/checkout@v4
111-
112-
# Griffe requires that Git tags are available.
113-
- run: git fetch --depth=1 --tags
114-
115-
- uses: actions/setup-python@v5
116-
with:
117-
python-version: "3.11"
118-
119-
# Install Griffe (use your preferred dependency manager).
120-
- run: pip install griffe
121-
122-
- run: griffe check -ssrc your_package
110+
- uses: actions/checkout@v5
111+
with:
112+
fetch-depth: 0 # We the need the full Git history.
113+
- uses: astral-sh/setup-uv@v6
114+
# The following command will compare current changes to latest tag.
115+
- run: uvx griffe check --search src --format github your_package_name
123116
```
124117
125-
The last step will fail the workflow if any breaking change is found. If you are part of [Insiders](../../insiders/index.md), you can format the output for GitHub, to enjoy GitHub annotations in PRs. See [GitHub format](#github) below.
118+
The last step will fail the workflow if any breaking change is found.
126119
127120
## Detected breakages
128121

0 commit comments

Comments
 (0)