Document batch distributor uploads
This commit is contained in:
@@ -78,10 +78,13 @@ missing directories, and unreadable files fail config loading.
|
||||
|
||||
### `notify`
|
||||
|
||||
`notify.distributor` controls distributor notification after successful report
|
||||
generation. It is disabled by default and does not add CLI flags. When enabled,
|
||||
weatherreporter uploads one distributor bundle per generated report after
|
||||
report rendering succeeds and final metadata is saved.
|
||||
`notify.distributor` controls distributor uploads after successful report
|
||||
rendering. It is disabled by default and does not add CLI flags. When enabled,
|
||||
`generate <report>` uploads one distributor bundle for the generated report
|
||||
after final metadata is saved. `run morning` and `run evening` use
|
||||
`notify.distributor.batch`: when batch notification is enabled and every
|
||||
planned report succeeds, weatherreporter uploads one distributor bundle that
|
||||
contains all managed Markdown reports from that batch.
|
||||
|
||||
- `enabled`: whether distributor notification config is active. Default:
|
||||
`false`.
|
||||
@@ -92,15 +95,18 @@ report rendering succeeds and final metadata is saved.
|
||||
- `timeout`: distributor operation timeout. Must be greater than zero when
|
||||
enabled. Default: `30s`.
|
||||
- `failure_policy`: must be `error` when enabled. Default: `error`.
|
||||
- `pipeline_id_template`: template for the distributor pipeline ID. Required
|
||||
when enabled. Default: empty.
|
||||
- `bundle_id_template`: template for distributor bundle IDs. Default:
|
||||
`weatherreporter.{location_id}.{report_id}`.
|
||||
- `idempotency_key_template`: template for distributor idempotency keys.
|
||||
Default: `{bundle_id}.{run_id}`.
|
||||
- `pipeline_id_template`: template for single-report distributor pipeline IDs.
|
||||
Required when enabled. Default: empty.
|
||||
- `bundle_id_template`: template for single-report distributor bundle IDs.
|
||||
Default: `weatherreporter.{location_id}.{report_id}`.
|
||||
- `idempotency_key_template`: template for single-report distributor
|
||||
idempotency keys. Default: `{bundle_id}.{run_id}`.
|
||||
- `report_path_templates`: ordered list of templates for Markdown report paths
|
||||
inside the distributor bundle. Each rendered path maps to the same managed
|
||||
Markdown report source. Default:
|
||||
inside distributor bundles. For `generate <report>`, each rendered path maps
|
||||
to the generated report's managed Markdown source. For `run morning` and
|
||||
`run evening`, the templates are rendered once per included report and each
|
||||
rendered path maps that report's managed Markdown source into the one batch
|
||||
bundle. Default:
|
||||
```yaml
|
||||
- "{valid_start_date}/{artifact_group}/{valid_start_date}-{artifact_group}-{run_id}.md"
|
||||
```
|
||||
@@ -116,7 +122,7 @@ report rendering succeeds and final metadata is saved.
|
||||
keys. Required when distributor notification and batch notification are
|
||||
enabled. Default: `{bundle_id}.{batch_run_id}`.
|
||||
|
||||
Supported template variables are `location_id`, `report_id`, `run_id`,
|
||||
Single-report templates support `location_id`, `report_id`, `run_id`,
|
||||
`artifact_group`, `batch_output_name`, `valid_start_date`, `valid_end_date`,
|
||||
`valid_start_time`, `valid_end_time`, `valid_start_stamp`, and
|
||||
`valid_end_stamp`. Date values use `YYYY-MM-DD`, time values use `HHMM`, and
|
||||
@@ -129,12 +135,16 @@ report stream. The rendered idempotency key is the per-run retry identity.
|
||||
|
||||
Batch templates support `location_id`, `batch`, `batch_run_id`, and
|
||||
`batch_started_date`. Batch idempotency templates may also use `bundle_id`.
|
||||
`batch_started_date` is the batch start date in the effective report timezone.
|
||||
Batch bundle IDs identify a logical batch stream; batch idempotency keys
|
||||
identify a specific retryable batch attempt.
|
||||
|
||||
Rendered report paths must be unique relative paths with `/` separators. They
|
||||
must not contain backslashes, empty path segments, `.`, `..`, `manifest.json`,
|
||||
or `.distributor.json`.
|
||||
or `.distributor.json`. In a batch upload, uniqueness is checked across every
|
||||
rendered bundle path for every included report before distributor is called.
|
||||
Managed Markdown report paths are the only upload source files; copies written
|
||||
with `--out` or `--out-dir` are never uploaded.
|
||||
|
||||
The upload token is read from the environment variable named by `token_env`
|
||||
after config loading and `secrets.directory` processing. Config files should
|
||||
|
||||
Reference in New Issue
Block a user