From 8992bb922ee74920be00d1da1a7a9010a5784573 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=9A=D0=BE=D0=BA=D0=BE=D1=81=20=D0=90=D1=80=D1=82=D0=B5?= =?UTF-8?q?=D0=BC=20=D0=9D=D0=B8=D0=BA=D0=BE=D0=BB=D0=B0=D0=B5=D0=B2=D0=B8?= =?UTF-8?q?=D1=87?= Date: Fri, 10 Jul 2026 16:40:22 +0700 Subject: [PATCH] docs: explain optional period.default_to and today fallback --- docs/CONFIG.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/CONFIG.md b/docs/CONFIG.md index 660e66f..d181886 100644 --- a/docs/CONFIG.md +++ b/docs/CONFIG.md @@ -32,6 +32,7 @@ redmine: period: precision: date default_from: "2026-06-01" + # default_to можно не указывать — тогда конец периода будет сегодня default_to: "2026-06-30" dynamic: false last_used: @@ -73,6 +74,23 @@ email: `last_used.from` / `last_used.to` записываются автоматически при `--commit`. Вручную редактировать не требуется. +### `period.default_to` — необязательное окончание периода + +Если `period.default_to` не задан, а `period.default_from` задан, инструмент +использует сегодняшнюю дату в качестве конца периода. + +```yaml +period: + default_from: "2026-07-01" + # default_to отсутствует → конец периода = сегодня +``` + +Это предотвращает устаревание периода, когда отчёт генерируется автоматически +(`--send`, `--commit`) без явного `--date`. + +Аналогично работает `DEFAULT_TO_DATE`: если переменная не задана, а +`DEFAULT_FROM_DATE` задана, конец периода = сегодня. + ### `--commit` — автофиксация периода Флаг `--commit` сохраняет использованный период в YAML-конфиг, чтобы следующий запуск автоматически начинался с нового периода. @@ -353,6 +371,10 @@ vim ~/.config/redmine-reporter/config.yml | `--init-config --force` | Перезаписать существующий YAML | | `--config-path PATH` | Сохранить YAML по указанному пути (по умолчанию `~/.config/redmine-reporter/config.yml`) | +Если `DEFAULT_TO_DATE` не задана, а `DEFAULT_FROM_DATE` задана, сгенерированный +YAML будет содержать пустое `default_to`, и при запуске инструмент использует +сегодняшнюю дату. + ### Проверка после миграции ```bash