From 93025c61d2ed74e6f096dd24a37428618c94a3ce Mon Sep 17 00:00:00 2001 From: Jesse Bannon Date: Sun, 3 Nov 2024 19:14:28 -0800 Subject: [PATCH] repro docs --- docs/source/guides/development/index.rst | 16 ++++++++++++++++ tests/e2e/{youtube => }/test_debug_repro.py | 0 2 files changed, 16 insertions(+) rename tests/e2e/{youtube => }/test_debug_repro.py (100%) diff --git a/docs/source/guides/development/index.rst b/docs/source/guides/development/index.rst index bf6b2c12..d0750e65 100644 --- a/docs/source/guides/development/index.rst +++ b/docs/source/guides/development/index.rst @@ -62,3 +62,19 @@ is highly recommended. TODO: screenshots of configuration +Debugging +--------- + +Debug Logs +^^^^^^^^^^^^^^^ +Run with ``--log-level debug`` to show all debug logs when running ytdl-sub. + + +Reproducing a Failing Subscription +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Subscriptions will dump their entire *compiled* yaml at the beginning of exeuction +when using ``--log-level debug``. This can be copy-pasted into the file +``resources/file_fixtures/repro.yaml``. + +Running the test ``e2e.test_debug_repro.TestReproduce.test_debug_log_repro`` +will fully reproduce that subscription in order to debug it. \ No newline at end of file diff --git a/tests/e2e/youtube/test_debug_repro.py b/tests/e2e/test_debug_repro.py similarity index 100% rename from tests/e2e/youtube/test_debug_repro.py rename to tests/e2e/test_debug_repro.py