Skip to content

Commit 9cc189e

Browse files
committed
docs: document plain-run outdated reporting and CI fail-on-stale
Operations guide only covered -r removal and "code 2 if changes needed". Note that a normal run now reports outdated annotations as a warning without writing, and that --ci fails on outdated annotations without requiring -r.
1 parent 0d42913 commit 9cc189e

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

docs/annotations/operations.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,10 @@ bin/cake annotate all --file src/View/AppView.php,plugins/My/src/View/Helper/MyH
7474
With `-r` / `--remove` there is basic support for finding and removing
7575
outdated annotations.
7676

77+
Even without `-r`, a normal run reports them as a warning
78+
(`N annotations outdated (run with -r to remove)`; `-v` lists each line)
79+
without modifying any file, so cruft stays discoverable on every run.
80+
7781
::: warning Alpha-quality feature
7882
Only use this after running the normal annotation flow and committing the
7983
result, so you can review and verify the changes. This feature is still in a
@@ -159,7 +163,9 @@ Use the `--ci` option along with `-d` (dry run):
159163
bin/cake annotate all -d --ci
160164
```
161165

162-
It will return error code `2` if any modification has to be done.
166+
It will return error code `2` if any modification has to be done — this
167+
includes outdated/removable annotations, which fail CI even without
168+
`-r` (no destructive flag required to enforce a clean state).
163169

164170
::: info Database setup
165171
This needs some additional setup, like running migrations prior to the call.

0 commit comments

Comments
 (0)