Skip to content

Link latest report from repository README - #313

Open
Priyankm23 wants to merge 1 commit into
creativecommons:mainfrom
Priyankm23:link-latest-report-311
Open

Priyankm23 wants to merge 1 commit into
creativecommons:mainfrom
Priyankm23:link-latest-report-311

Conversation

@Priyankm23

Copy link
Copy Markdown
Contributor

Fixes

Description

This PR addresses #311 by linking the latest quarterly report directly from the root README.md and updating scripts/3-report/zzz-notes.py so the link is refreshed automatically when new reports are generated.
The ## Latest report section is placed immediately after ## Overview so visitors can access the latest report right away without needing to dig or scroll past setup instructions.

Technical details

  • Added a ## Latest report section to the root README.md wrapped with <!-- LATEST_REPORT start --> and <!-- LATEST_REPORT end --> markers.
  • Added latest_report(args) in scripts/3-report/zzz-notes.py that:
    • Runs only when --enable-save is set.
    • Determines the latest available report by checking quarters in data/ that have a completed README.md report.
    • Skips updating the root README.md if the target quarter is older than the latest available report.
    • Replaces the link between the comment markers with the current quarter link.
  • Updated main() in zzz-notes.py to stage and commit the updated root README.md when --enable-git is used, ensuring git status is preserved across both commits.
  • Kept all line lengths within the 79-character limit for flake8 compliance.

Tests

  • Verified dry-run behavior (--enable-save omitted) leaves README.md unchanged.
  • Tested running zzz-notes.py with --quarter 2026Q3 --enable-save and confirmed it updates the root README.md link to the Q3 report.
  • Tested running zzz-notes.py with an older quarter (2026Q2) and confirmed it logs that the quarter is older and skips updating the root README.md.
  • Ran flake8 scripts/3-report/zzz-notes.py (0 errors).
  • Ran git diff --check (clean).

Checklist

  • I have read and understood the Developer Certificate of Origin (DCO), below, which covers the contents of this pull request (PR).
  • My pull request doesn't include code or content generated with AI (also see Avoiding generative AI development tools - Creative Commons Open Source).
  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@Priyankm23
Priyankm23 requested review from a team as code owners October 10, 2026 03:13
@Priyankm23
Priyankm23 requested review from TimidRobot and possumbilities and removed request for a team October 10, 2026 03:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In review

Development

Successfully merging this pull request may close these issues.

Link latest report from repository README

2 participants