Skip to content

Comments

Add consolidated metadata manifest for full pipeline auditability#2

Open
AhmedAli58 wants to merge 2 commits intostiles:mainfrom
AhmedAli58:main
Open

Add consolidated metadata manifest for full pipeline auditability#2
AhmedAli58 wants to merge 2 commits intostiles:mainfrom
AhmedAli58:main

Conversation

@AhmedAli58
Copy link

Adds a single metadata.json manifest generated on each successful publish. Consolidates download, normalization, and publish metadata into one auditable source of truth, improving reproducibility, provenance, and trust.

@stiles
Copy link
Owner

stiles commented Jan 13, 2026

Hi @AhmedAli58. Thanks for this contribution! The consolidated metadata manifest is a good idea for improving pipeline auditability. Your implementation looks solid and the code is well-documented.

Before merging, could you please address these items:

Required:

  1. Add unit tests for the new _create_consolidated_metadata() function
  2. Update README.md to document the new metadata.json file and its fields
  3. Add a CHANGELOG.md entry for this feature

Recommended:
4. Add a metadata_version field to the consolidated metadata for future schema evolution
5. Consider warning/failing if critical fields are missing rather than silently using empty defaults

Let me know if you have questions about any of these! Looking forward to the updates.

…_metadata()ated_metadata function

Add tests for creating consolidated metadata, including success and missing files scenarios.Add initial tests for the consolidated metadata creation function, including missing file case.
@AhmedAli58
Copy link
Author

Hi, I’ve addressed all the requested items: added unit tests, updated the README with metadata.json documentation, and added a CHANGELOG entry. The PR now includes the requested changes. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants