Rename rolling report to hourly
This commit is contained in:
@@ -7,8 +7,8 @@ This roadmap defines the concrete implementation sequence for
|
||||
will implement each stage in order.
|
||||
|
||||
This is a future-work roadmap. Until a stage is implemented, non-roadmap docs
|
||||
must not describe `GeneratedText`, embedded report templates, or
|
||||
`weatherreporter generate hourly` as available behavior.
|
||||
must not describe `GeneratedText`, embedded report templates, or other
|
||||
unimplemented GeneratedText behavior as available.
|
||||
|
||||
## Source Feature Roadmap
|
||||
|
||||
@@ -26,8 +26,8 @@ for reaching that shape.
|
||||
|
||||
- Implement the first GeneratedText path for the rolling next-hours report,
|
||||
named `hourly`.
|
||||
- Replace planned/public `near_term` naming with `hourly`; do not keep a
|
||||
public `near-term` alias.
|
||||
- Use `hourly` as the only planned public name for the rolling next-hours
|
||||
report; do not keep compatibility aliases from retired roadmap terminology.
|
||||
- Use report ID `hourly`, artifact group `hourly`, batch output name
|
||||
`hourly.md`, and CLI command `weatherreporter generate hourly`.
|
||||
- Keep the rolling report explicit-generation only; do not add scheduled batch
|
||||
@@ -61,7 +61,7 @@ planned public name for the rolling next-hours report.
|
||||
Files to inspect:
|
||||
|
||||
- `docs/roadmap/generated-text.md`
|
||||
- `docs/roadmap/near-term.md`
|
||||
- the superseded roadmap file for the retired rolling-report name
|
||||
- `docs/roadmap/future.md`
|
||||
- `docs/roadmap/implementation.md`
|
||||
- `internal/app/app.go`
|
||||
@@ -70,30 +70,32 @@ Files to inspect:
|
||||
|
||||
Implementation:
|
||||
|
||||
- Replace `docs/roadmap/near-term.md` with a short superseded note pointing to
|
||||
`docs/roadmap/generated-text.md`, or delete it if the repository policy at
|
||||
implementation time prefers removing obsolete roadmap files.
|
||||
- Ensure no roadmap instructs a future agent to implement public
|
||||
`near_term` / `near-term` behavior.
|
||||
- If partial `near_term` code already exists, rename it to `hourly` rather
|
||||
than adding aliases:
|
||||
- `ReportNearTerm` -> `ReportHourly`;
|
||||
- `report.NearTerm` -> `report.Hourly`;
|
||||
- CLI command `near-term` -> `hourly`;
|
||||
- artifact group `near-term` -> `hourly`;
|
||||
- Replace the superseded roadmap file for the retired rolling-report name with
|
||||
a short note pointing to `docs/roadmap/generated-text.md`, or delete it if
|
||||
the repository policy at implementation time prefers removing obsolete
|
||||
roadmap files.
|
||||
- Ensure no roadmap instructs a future agent to implement retired public
|
||||
identifiers for the rolling report.
|
||||
- If partial code using retired identifiers already exists, rename it to
|
||||
`hourly` rather than adding aliases:
|
||||
- app report kind -> `ReportHourly`;
|
||||
- report ID constant -> `report.Hourly`;
|
||||
- CLI command -> `hourly`;
|
||||
- artifact group -> `hourly`;
|
||||
- prompt IDs and tests updated to hourly names.
|
||||
- Do not add compatibility aliases for `near-term`.
|
||||
- Do not add compatibility aliases for retired command or config names.
|
||||
|
||||
Acceptance criteria:
|
||||
|
||||
- Active roadmap docs use `hourly` for the rolling report.
|
||||
- No active roadmap describes `near_term` as the target public report ID.
|
||||
- No active roadmap describes a retired identifier as the target public report
|
||||
ID.
|
||||
- Existing code compiles after any rename work.
|
||||
|
||||
Suggested validation:
|
||||
|
||||
```bash
|
||||
rg -n "near_term|near-term|NearTerm" docs internal
|
||||
rg -n 'near[_-]term|Near''Term' docs internal
|
||||
go test ./internal/app ./internal/report ./internal/cli
|
||||
```
|
||||
|
||||
@@ -208,7 +210,7 @@ Implementation:
|
||||
- no daily summaries, daypart summaries, or storm summary.
|
||||
- Add config report aliases:
|
||||
- `hourly`
|
||||
- reject or do not recognize `near_term` / `near-term`.
|
||||
- reject or do not recognize retired rolling-report config keys.
|
||||
- Add app report kind `ReportHourly = "hourly"` and map it to
|
||||
`report.Hourly`.
|
||||
- Add CLI parsing and help for:
|
||||
@@ -651,17 +653,17 @@ Files to inspect:
|
||||
Implementation:
|
||||
|
||||
- Add CLI command tests for `generate hourly`.
|
||||
- Reject `generate near-term`.
|
||||
- Reject the retired rolling-report command name.
|
||||
- Reject hourly `--date`, `--start`, `--end`, and duration-like flags.
|
||||
- Add config override tests for `reports.hourly.deterministic_modules`.
|
||||
- Ensure `near_term` and `near-term` report config keys are rejected.
|
||||
- Ensure retired rolling-report config keys are rejected.
|
||||
- Add app/CLI workflow tests using fake Scriptorium structured output.
|
||||
- Update examples only if they enumerate report module overrides.
|
||||
|
||||
Acceptance criteria:
|
||||
|
||||
- `weatherreporter --help` lists `generate hourly`;
|
||||
- `generate near-term` is not accepted;
|
||||
- the retired rolling-report command name is not accepted;
|
||||
- hourly config overrides validate compatible modules;
|
||||
- incompatible daily/daypart modules fail clearly for hourly;
|
||||
- examples load successfully.
|
||||
@@ -693,13 +695,13 @@ Files to inspect and update:
|
||||
- new `docs/internal/reporttemplate.md`
|
||||
- `docs/integrations/scriptorium.md`
|
||||
- `docs/roadmap/future.md`
|
||||
- `docs/roadmap/near-term.md`
|
||||
- the superseded roadmap file for the retired rolling-report name
|
||||
- `examples/config.yml`, only if examples changed
|
||||
|
||||
Documentation requirements:
|
||||
|
||||
- Non-roadmap docs describe only implemented hourly and GeneratedText behavior.
|
||||
- `docs/cli.md` documents `generate hourly`, not `generate near-term`.
|
||||
- `docs/cli.md` documents `generate hourly`, not the retired command name.
|
||||
- `docs/config.md` documents `reports.hourly` only if override support is
|
||||
implemented.
|
||||
- Internal docs distinguish:
|
||||
@@ -711,20 +713,22 @@ Documentation requirements:
|
||||
- Scriptorium integration docs include the structured-output command actually
|
||||
used by the adapter.
|
||||
- State docs list generated-text artifacts and metadata links.
|
||||
- `docs/roadmap/near-term.md` is deleted or marked superseded.
|
||||
- the superseded roadmap file for the retired rolling-report name is deleted
|
||||
or marked superseded.
|
||||
- Deferred migrations for other report types stay under roadmap docs only.
|
||||
|
||||
Acceptance criteria:
|
||||
|
||||
- No non-roadmap docs describe unimplemented generated-text migrations.
|
||||
- No active docs describe `near_term` as the target public report.
|
||||
- No active docs describe retired rolling-report identifiers as the target
|
||||
public report.
|
||||
- Maintained examples remain valid.
|
||||
|
||||
Suggested validation:
|
||||
|
||||
```bash
|
||||
go test ./internal/config
|
||||
rg -n "near_term|near-term|NearTerm" docs internal examples
|
||||
rg -n 'near[_-]term|Near''Term' docs internal examples
|
||||
git diff --check
|
||||
```
|
||||
|
||||
@@ -745,7 +749,7 @@ git diff --check
|
||||
Manual checks:
|
||||
|
||||
- `weatherreporter --help` lists `generate hourly`.
|
||||
- `weatherreporter --help` does not list `generate near-term`.
|
||||
- `weatherreporter --help` does not list the retired rolling-report command.
|
||||
- generated hourly Markdown has deterministic headings and section order.
|
||||
- GeneratedText JSON is persisted separately from deterministic facts.
|
||||
- render context JSON is persisted and readable.
|
||||
|
||||
Reference in New Issue
Block a user