Skip to content

Refresh address checks before deployment builds - #686

Open
rossgalloway wants to merge 3 commits into
masterfrom
ross/address-check-build-reports
Open

rossgalloway wants to merge 3 commits into
masterfrom
ross/address-check-build-reports

Conversation

@rossgalloway

@rossgalloway rossgalloway commented Oct 12, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

The address banner kept showing a July snapshot because checks ran after the CI build and outside Vercel's build. Some recorded failures also left the result green. Builds now collect a fresh report before rendering, publish a warning banner for completed mismatches, and stop when checks cannot complete.

#685 has merged. This PR targets master and includes the resolved package-script conflict, preserving both NatSpec and address-check tests.

How to review

  • Review scripts/withAddressChecks.ts and the package scripts. Both build and start collect and validate a fresh report before proceeding. build:site remains an explicit way to render an existing snapshot.
  • Review scripts/runAddressChecks.ts and scripts/addressCheckReport.ts. Exit 0 means passed, exit 1 means completed with mismatches, and exit 2 means incomplete. A checker crash cannot reuse a previous green report.
  • Review the release and gauge checks. Latest-release mismatches, documented releases absent from the registry, unknown registry releases, and gauge-count mismatches fail their group. Optional contract getters still support legacy responses, but transport errors propagate.
  • Review the CI workflows. A completed mismatch permits the website build but fails the address-check result step. PR and scheduled runs retain their reports for 30 days. Scheduled checks retain their existing mismatch issue reporting; they do not commit snapshots or trigger deployments.

The checked-in snapshot records the earlier registry discrepancy. Live checks on October 27 now report 3.1.1 as latest, with all V3, veYFI, and multisig checks passing and no mismatches. Both documentation CI runs passed after rerunning against the updated registry. Deployment builds always collect their own fresh report.

Test plan

  • bun run test:natspec — all 8 checks passed after merging master.

  • bun run test:addresses — 30 regression checks passed, including partial RPC failures, legacy getter fallbacks, incomplete reports, and development startup with warning data.

  • RPC_URI_FOR_1=https://rpc.yearn.fi/chain/1 bun run build — collected live mainnet results before a successful website build and AI exports.

  • Reran both documentation CI jobs on October 27; the live address checks, regression tests, site build, and CI result step all passed. Verified the retained report has all three check groups passing and no failed checks.

  • Parsed both updated GitHub Actions workflows.

  • Verified the October 27 preview shows a fresh passing banner after the registry update.

  • git diff --check passed.

  • GitHub Markdown link lint and Vercel deployment passed at 249a4544e.

  • All GitHub checks passed at 249a4544e after the registry update and CI reruns.

Risk / impact

Builds now require mainnet RPC availability. Completed mismatches publish a fresh warning page, while unavailable or incomplete reads stop the build. Future mismatches will fail address-check CI while allowing the separate Vercel preview workflow to publish the completed warning report. All validation is read-only. Reverting this PR restores the previous build and checking behavior.

@github-actions

github-actions Bot commented Oct 12, 2026 •

Copy link
Copy Markdown

Deploy preview for yearn-docs ready!

Project:yearn-docs
Status: ✅  Deploy successful!
Preview URL:https://yearn-docs-qaeoocs3b-yearn.vercel.app
Latest Commit:ecd2d86

Deployed with vercel-action

matheus1lva and others added 3 commits October 27, 2026 12:29
The address banner used a committed July snapshot because validation ran
only after the CI build and outside Vercel's build. Latest-release and
missing-entry failures could also leave the overall result green.

- Collect a fresh report before production builds and local startup
- Publish warning banners for completed mismatches and fail address CI
- Stop builds on incomplete checks, including partial RPC failures
- Propagate missing-release and gauge-count failures into group results
- Preserve legacy getter fallbacks for completed contract observations
- Retain CI and scheduled reports as downloadable artifacts
- Show the check timestamp on warning banners

Validated 30 regression checks, a live mainnet build, workflow parsing,
the CI failure step, and the private build preview. Mainnet currently
reports 3.1.0 as latest and does not list the documented 3.1.1 release.

This branch was successfully deployed

1 active deployment
preview — ecd2d865 Deployed Oct 27, 2026 by github-actions[bot]
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