Override today for testing with reproducible output

hugovk · hugovk · commit b163ac4faf73 · 2023-01-22T14:01:35.000+02:00
diff --git a/.github/workflows/release-cycle.yml b/.github/workflows/release-cycle.yml
@@ -26,10 +26,7 @@ jobs:
         run: python -m pip install jinja2
 
       - name: Generate release cycle output
-        run: python -I -bb -X dev -X warn_default_encoding -W error _tools/generate_release_cycle.py
-
-      - name: Ignore release-cycle.svg, which encodes the current date
-        run: git restore include/release-cycle.svg
+        run: python -I -bb -X dev -X warn_default_encoding -W error _tools/generate_release_cycle.py --today 2023-01-21
 
       - name: Check for differences
         run: |
diff --git a/_tools/generate_release_cycle.py b/_tools/generate_release_cycle.py
@@ -1,6 +1,7 @@
 """Read in a JSON and generate two CSVs and an SVG file."""
 from __future__ import annotations
 
+import argparse
 import csv
 import datetime as dt
 import json
@@ -66,7 +67,7 @@ def write_csv(self) -> None:
                 csv_file.writeheader()
                 csv_file.writerows(versions.values())
 
-    def write_svg(self) -> None:
+    def write_svg(self, today: str) -> None:
         """Output SVG file."""
         env = jinja2.Environment(
             loader=jinja2.FileSystemLoader("_tools/"),
@@ -123,17 +124,28 @@ def format_year(year: int) -> str:
                 years=range(first_date.year, last_date.year),
                 LINE_HEIGHT=LINE_HEIGHT,
                 versions=list(reversed(self.sorted_versions)),
-                today=dt.date.today(),
+                today=dt.datetime.strptime(today, "%Y-%m-%d").date(),
                 year_to_x=year_to_x,
                 date_to_x=date_to_x,
                 format_year=format_year,
             ).dump(f)
 
 
 def main() -> None:
+    parser = argparse.ArgumentParser(
+        description=__doc__, formatter_class=argparse.ArgumentDefaultsHelpFormatter
+    )
+    parser.add_argument(
+        "--today",
+        default=str(dt.date.today()),
+        metavar=" YYYY-MM-DD",
+        help="Override today for testing",
+    )
+    args = parser.parse_args()
+
     versions = Versions()
     versions.write_csv()
-    versions.write_svg()
+    versions.write_svg(args.today)
 
 
 if __name__ == "__main__":
