Skip to content

feat(specifications): show maintainer review status on each specification page - #124

Open
etienne0101 wants to merge 1 commit into
mainfrom
feat/maintainer-review-status/2026-11-20
Open

etienne0101 wants to merge 1 commit into
mainfrom
feat/maintainer-review-status/2026-11-20

Conversation

@etienne0101

Copy link
Copy Markdown
Contributor

Summary

Each specification page now shows where its assessment stands in the review by its maintainer, just under "Maintained by":

  • Assessment reviewed by maintainer (green, with date)
  • Assessment under review by maintainer (yellow, with date)
  • Assessment review requested (yellow, with date, or no date when there is no answer yet)

How it works

  • One issue per specification, labelled maintainer-review, with one status label: review: requested, review: in progress, review: no answer or review: reviewed. The issue body only holds the specification id and the review date.
  • The site reads these issues at build time (scripts/maintainer_review.py). If GitHub cannot be reached, the build still succeeds and no status is shown.
  • When a status label is added, a workflow removes the previous status label, writes today's date in the issue and starts the website deploy.
  • Only issues with the maintainer-review label are read. Only the team can add labels, so visitors cannot publish a status.
  • The status is also published in the JSON API and the CSV export (status and date only).

Changes

  • scripts/maintainer_review.py: reads and parses the review issues
  • hooks/specifications.py, specifications.css: status line under "Maintained by"
  • scripts/spec_api.py: maintainer_review field in the API, OpenAPI schema and CSV export
  • .github/workflows/maintainer_review_redeploy.yml: label handling and redeploy
  • .github/ISSUE_TEMPLATE/maintainer-review.yml: form for new review issues
  • scripts/seed_maintainer_reviews.py: one-off script used to create the 44 existing issues from the tracking sheet

@etienne0101
etienne0101 requested a review from richfab November 20, 2026 17:27

This branch has not been deployed

No deployments
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.

1 participant