feat: publish weekly producer contract artifact #28
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # Weekly producer artifact contract | ||
|
|
||
| This is the producer-side boundary for `political_event_weekly.v1`. It is a | ||
| pure local adapter: callers provide the completed UTC week, `as_of`, actual | ||
| UTC `generated_at`, producer full SHA, provenance identifier, input files, and | ||
| feed status. The adapter never infers dates, reads the wall clock, fetches | ||
| feeds, or uploads files. | ||
|
|
||
| ## Artifact | ||
|
|
||
| - Name: `political-event-weekly-v1` | ||
| - File set: exactly `weekly_manifest.json` | ||
| - Retention: 30 days, configured by the consuming artifact workflow; it is not | ||
| inferred from report content. | ||
| - Bytes: canonical `political_event_weekly.v1` manifest bytes from the merged | ||
| weekly manifest serializer. | ||
|
|
||
| The input file paths are repository-relative POSIX paths under the trusted | ||
| `base_dir`. They must be regular, non-symlink files. Their SHA-256 and CSV row | ||
| counts are read from those exact files. The feed status file must be one of | ||
| the declared inputs, and its counters must agree with every feed entry. Any | ||
| failed, stale, missing, partial, malformed, or mismatched input fails before | ||
| the output directory is created. | ||
|
|
||
| The CLI requires all period, timestamp, producer, provenance, and path inputs | ||
| explicitly. Upload availability is an external workflow gate: callers must | ||
| only upload the returned artifact after successful local readback; an upload | ||
| step that cannot accept the exact single-file artifact must fail the workflow, | ||
| not publish a success signal. | ||
|
|
||
| The RSS source workflow now supplies this boundary without changing fetching: | ||
| scheduled runs execute Monday UTC after the previous ISO week is complete and | ||
| derive that week using the documented producer rule; manual runs require both | ||
| `period_start` and `as_of`. It uploads the single manifest with a 30-day | ||
| retention setting. Other workflows and downstream consumers are unchanged. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| #!/usr/bin/env python3 | ||
| """Write a producer-owned ``political_event_weekly.v1`` manifest artifact.""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import argparse | ||
| from datetime import datetime | ||
| from pathlib import Path | ||
| import sys | ||
|
|
||
| sys.path.insert(0, str(Path(__file__).resolve().parents[1] / "src")) | ||
|
|
||
| from political_event_tracking_research.weekly_contract import WeeklyContractError | ||
| from political_event_tracking_research.weekly_producer import write_weekly_artifact_from_files | ||
|
|
||
|
|
||
| def _generated_at(value: str) -> datetime: | ||
| if not value.endswith("Z"): | ||
| raise argparse.ArgumentTypeError("generated_at_invalid") | ||
| try: | ||
| return datetime.fromisoformat(value[:-1] + "+00:00") | ||
| except ValueError as error: | ||
| raise argparse.ArgumentTypeError("generated_at_invalid") from error | ||
|
|
||
|
|
||
| def main() -> None: | ||
| parser = argparse.ArgumentParser(description="Write a validated weekly producer artifact.") | ||
| parser.add_argument("paths", nargs="+", help="Explicit input files, relative to --base-dir.") | ||
| parser.add_argument("--base-dir", required=True) | ||
| parser.add_argument("--output-dir", required=True) | ||
| parser.add_argument("--feed-status", required=True) | ||
| parser.add_argument("--period-start", required=True) | ||
| parser.add_argument("--as-of", required=True) | ||
| parser.add_argument("--generated-at", required=True, type=_generated_at) | ||
| parser.add_argument("--run-mode", required=True, choices=("scheduled", "manual")) | ||
| parser.add_argument("--producer-ref", required=True) | ||
| parser.add_argument("--source-provenance", required=True) | ||
| args = parser.parse_args() | ||
| try: | ||
| write_weekly_artifact_from_files( | ||
| args.paths, | ||
| base_dir=args.base_dir, | ||
| output_dir=args.output_dir, | ||
| feed_status_path=args.feed_status, | ||
| period_start=args.period_start, | ||
| as_of=args.as_of, | ||
| generated_at=args.generated_at, | ||
| run_mode=args.run_mode, | ||
| producer_ref=args.producer_ref, | ||
| source_provenance=args.source_provenance, | ||
| ) | ||
| except WeeklyContractError as error: | ||
| raise SystemExit(error.code) from None | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| main() |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this workflow the fetch step still uses
--continue-on-feed-error, so a single RSS outage produces usable CSVs plus a nonzerofailed_feed_count; however this new weekly artifact step runs before the existing live-output commit/upload path, and the producer exits on incomplete feed status. In scheduled runs where one feed fails, the job now stops here and skips publishing the ordinary RSS outputs that were previously refreshed from the healthy feeds, so the weekly artifact failure should be isolated or moved after the existing publication path if partial RSS runs should remain available.Useful? React with 👍 / 👎.