docs: explain optional period.default_to and today fallback
This commit is contained in:
@@ -32,6 +32,7 @@ redmine:
|
|||||||
period:
|
period:
|
||||||
precision: date
|
precision: date
|
||||||
default_from: "2026-06-01"
|
default_from: "2026-06-01"
|
||||||
|
# default_to можно не указывать — тогда конец периода будет сегодня
|
||||||
default_to: "2026-06-30"
|
default_to: "2026-06-30"
|
||||||
dynamic: false
|
dynamic: false
|
||||||
last_used:
|
last_used:
|
||||||
@@ -73,6 +74,23 @@ email:
|
|||||||
|
|
||||||
`last_used.from` / `last_used.to` записываются автоматически при `--commit`. Вручную редактировать не требуется.
|
`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` — автофиксация периода
|
||||||
|
|
||||||
Флаг `--commit` сохраняет использованный период в YAML-конфиг, чтобы следующий запуск автоматически начинался с нового периода.
|
Флаг `--commit` сохраняет использованный период в YAML-конфиг, чтобы следующий запуск автоматически начинался с нового периода.
|
||||||
@@ -353,6 +371,10 @@ vim ~/.config/redmine-reporter/config.yml
|
|||||||
| `--init-config --force` | Перезаписать существующий YAML |
|
| `--init-config --force` | Перезаписать существующий YAML |
|
||||||
| `--config-path PATH` | Сохранить YAML по указанному пути (по умолчанию `~/.config/redmine-reporter/config.yml`) |
|
| `--config-path PATH` | Сохранить YAML по указанному пути (по умолчанию `~/.config/redmine-reporter/config.yml`) |
|
||||||
|
|
||||||
|
Если `DEFAULT_TO_DATE` не задана, а `DEFAULT_FROM_DATE` задана, сгенерированный
|
||||||
|
YAML будет содержать пустое `default_to`, и при запуске инструмент использует
|
||||||
|
сегодняшнюю дату.
|
||||||
|
|
||||||
### Проверка после миграции
|
### Проверка после миграции
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
Reference in New Issue
Block a user