Add build-sequence-suummary.json

Machine readable version of the current markdown table

Useful in pipeline environments to filter skipped or prebuilt packages from a subsequent twine publish

Signed-off-by: Pris Nasrat <[email protected]>

Author: pnasrat

e2e/test_build_order.sh

@@ -51,6 +51,9 @@ $OUTDIR/sdists-repo/downloads/pbr-*.tar.gz
 $OUTDIR/work-dir/logs/stevedore-*.log
 $OUTDIR/work-dir/logs/setuptools-*.log
 $OUTDIR/work-dir/logs/pbr-*.log
+
+$OUTDIR/work-dir/build-sequence-summary.md
+$OUTDIR/work-dir/build-sequence-summary.json
 "
 
 pass=true

src/fromager/commands/build.py

@@ -44,6 +44,12 @@ class BuildSequenceEntry:
     wheel_filename: pathlib.Path
     skipped: bool = False
 
+    @staticmethod
+    def dict_factory(x):
+        return {
+            k: str(v) if isinstance(v, pathlib.Path | Version) else v for (k, v) in x
+        }
+
     def __lt__(self, other):
         if not isinstance(other, BuildSequenceEntry):
             return NotImplemented
@@ -278,6 +284,15 @@ def _summary(ctx: context.WorkContext, entries: list[BuildSequenceEntry]) -> Non
         console = rich.console.Console(file=f, width=sys.maxsize)
         console.print(*output, sep="\n\n")
 
+    with open(ctx.work_dir / "build-sequence-summary.json", "w", encoding="utf-8") as f:
+        json.dump(
+            [
+                dataclasses.asdict(e, dict_factory=BuildSequenceEntry.dict_factory)
+                for e in entries
+            ],
+            f,
+        )
+
 
 def _create_table(entries: list[BuildSequenceEntry], **table_kwargs) -> Table:
     table = Table(**table_kwargs)