Skip to content

fix(docs): don't let upstream metadata scripts block the docs build - #27

Open
Gabrielebattimelli wants to merge 1 commit into
mainfrom
fix/docs-artifact-resilience
Open

Gabrielebattimelli wants to merge 1 commit into
mainfrom
fix/docs-artifact-resilience

Conversation

@Gabrielebattimelli

Copy link
Copy Markdown
Member

Problem

physlib.io/docs is stuck on the v4.32.0 build. DocsArtifact.yml has failed on all 87 runs since 2026-08-17.

The docs build itself isn't what's failing. The job stops earlier, at lake exe TODO_to_yml mkFile. That script imports Physlib, QuantumInfo and PhyslibAlpha into one environment (upstream scripts/MetaPrograms/TODO_to_yml.lean:333) and throws when two of them declare the same name. Right now there are two clashes:

  • QuantumMechanics.HarmonicOscillator.potentialFunction in Physlib and PhyslibAlpha (upstream #1522)
  • POVM in QuantumInfo and PhyslibAlpha (upstream #1694)

There's also a deadline. The last good artifact expires on 2026-11-15. After that, download-docs.js finds no docs and exits 1 on purpose, so every site build would fail.

Change

  • The TODO list, informal graph and stats steps get continue-on-error: true. The steps that use their output only run if they succeeded.
  • A final step adds a warning annotation to the run when any of them failed, so the green run doesn't hide the problem.
  • If TODO.yml isn't generated, the site uses the copy committed in web2/data.

The TODO page stays out of date until the name clashes are fixed upstream.

Testing

The YAML parses, and each step has the right condition. The docs step hasn't run since v4.32.0, so a workflow_dispatch run on this branch is the real test.

🤖 Generated with Claude Code

DocsArtifact.yml has failed on all 87 runs since 2026-08-17, so
physlib.io/docs is stuck at the last v4.32.0 build. The docs themselves
are fine: the job dies earlier, at `lake exe TODO_to_yml`, which imports
Physlib, QuantumInfo and PhyslibAlpha into one environment and throws
whenever two of them declare the same name (currently
QuantumMechanics.HarmonicOscillator.potentialFunction and POVM).

Let the TODO list, informal graph and stats steps fail without failing
the job, skip the steps that depend on their output, and raise a warning
annotation when any of them did. The docs are then still built and
deployed, and the site falls back to the TODO.yml committed in web2/data.

This also matters before 2026-11-15, when the last good artifact expires
and download-docs.js would start failing every site build.
Copilot AI balanced review requested due to automatic review settings September 29, 2026 20:16

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

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.

2 participants