Skip to content

Commit c69879e

Browse files
committed
docs(CHANGES) Note libvcs sync-time silencing and the new log dir layout
why: Two user-visible behaviours landed without CHANGES updates: the libvcs WARNING/ERROR silencing during human-mode sync (so the ``|git| (rye) Failed to determine ...`` line no longer competes with ``✗ Failed syncing rye: ...``), and the debug-log directory regrouping under ``$TMPDIR/vcspull/`` (and ``$TMPDIR/vcspull-test/`` under pytest). Releasing without these would leave the changelog describing behaviour that no longer matches reality. what: - ``CHANGES``: extend the existing "libvcs is quiet by default" unreleased section with a paragraph spelling out the sync-time StreamHandler silencing -- name the rye repro because that is the symptom users will recognise -- and stress that the debug log file still captures the entry for post-mortem. - ``CHANGES``: rewrite the debug-log section to advertise the new ``$TMPDIR/vcspull/debug-<ts>-<pid>.log`` path (production) and the ``$TMPDIR/vcspull-test/...`` test-mode safety net, replacing the stale ``$TMPDIR/vcspull-debug-...`` description.
1 parent 7b5c3a2 commit c69879e

1 file changed

Lines changed: 19 additions & 6 deletions

File tree

CHANGES

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,16 @@ Pass `-v` to see libvcs `INFO` (`Updating to 'main'.`,
6464
trail). The npm/pnpm-style debug log file always captures `DEBUG`
6565
regardless of verbosity.
6666

67+
During `vcspull sync` itself the libvcs terminal stream is also
68+
silenced for `WARNING` / `ERROR` records at default verbosity --
69+
libvcs's `|git| (rye) Failed to determine current branch` warning
70+
was duplicating the same content vcspull's own `✗ Failed syncing
71+
rye: Command failed with code 128: git symbolic-ref HEAD --short`
72+
line already carried, breaking the
73+
`✓ Synced X / ✗ Failed X / - Timed out X` rhythm. The debug log
74+
file still captures every libvcs entry, so a post-mortem after a
75+
failure has the full trace.
76+
6777
Root cause for the regression that prompted this: `setup_file_logger`
6878
raised both the `vcspull` and `libvcs` loggers to `DEBUG` so the
6979
`FileHandler` could capture full traces, but the terminal `StreamHandler`
@@ -113,12 +123,15 @@ colours are turned off.
113123
#### `vcspull sync`: per-invocation debug log (npm/pnpm style)
114124

115125
Every `vcspull sync` invocation now writes a debug log to
116-
`$TMPDIR/vcspull-debug-<timestamp>-<pid>.log`. Clean runs stay quiet -- the
117-
log path is only surfaced to the terminal when at least one repository
118-
failed or timed out. Override the destination with `--log-file PATH`, or
119-
disable entirely with `--no-log-file`. The log captures the full libvcs
120-
per-repo activity (progress callback output, exit codes, errors) so a hang
121-
can be post-mortemed even after the CLI has moved on.
126+
`$TMPDIR/vcspull/debug-<timestamp>-<pid>.log` (or
127+
`$TMPDIR/vcspull-test/debug-<timestamp>-<pid>.log` when running under
128+
pytest, an automatic safety net so the production log dir stays
129+
uncontaminated by test runs). Clean runs stay quiet -- the log path is
130+
only surfaced to the terminal when at least one repository failed or
131+
timed out. Override the destination with `--log-file PATH`, or disable
132+
entirely with `--no-log-file`. The log captures the full libvcs per-repo
133+
activity (progress callback output, exit codes, errors) so a hang can be
134+
post-mortemed even after the CLI has moved on.
122135

123136
### Dependencies
124137

0 commit comments

Comments
 (0)