Improve reference-generation tooling + coverage#3430
Merged
anegg0 merged 6 commits intoJul 1, 2026
Conversation
Add scripts/generate-contract-addresses.ts (+ contract-addresses.data.ts) to build the Chain info contract-address partial. Protocol-core and token bridge addresses are read live from @arbitrum/sdk; contracts the SDK does not expose (core proxy admin, fraud proof, resource constraint manager, canonical factories) and constant precompiles live in the data file. Addresses are checksummed via getAddress so the strict AddressExplorerLink never throws. Adds a --check mode for CI. Regenerating corrected a stale Arbitrum Sepolia Rollup address and a malformed ResourceConstraintManager row, and added RollupCreator / TokenBridgeCreator tables (TW-884).
Add scripts/lib/generated-partial.ts (writeOrCheck + --check + runScript) and adopt it in the precompile, contract-address, and glossary generators so they share deterministic Prettier-formatted output, a uniform --check mode, and one error/exit path. De-duplicate the @@name=value@@ syntax into scripts/lib/variable-refs.js, consumed by both markdown-preprocessor.js and update-variable-references.ts; the updater also gains a --check mode. Make build-glossary deterministic (drop the generation timestamp), fail loudly on a missing glossary dir instead of emitting an empty file, and remove its dead renderKey/imports/items code. Add yarn generate and yarn generate:check.
check-releases.ts now updates nitroVersionTag alongside latestNitroNodeImage from the latest Nitro release, and the daily workflow regenerates the precompile tables after a bump so their version-pinned links stay fresh. Removes the dead createPullRequest function and the ESM-only @actions/* imports that prevented the script from loading under tsx, replacing core.setOutput with a GITHUB_OUTPUT write.
Add @types/react-dom and .d.ts declarations for untyped local modules (globalVars.js, precompilesInformation.js, sidebars.js, the CentralizedAuction jsx components) plus an ambient decl for markdown-link-extractor. Add real types and null-guards across components and scripts (VendingMachine, Modal, find-orphan-pages, precompile generator, Quicklooks, D3EdgeTree, Footer, Layout, check-markdown, and others). Remove the now-unused @actions/* devDependencies. Full-project typecheck is now green, so commits no longer require HUSKY=0.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
anegg0
changed the title
pete-vielhaber
approved these changes
Jul 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR makes some improvements to the ref generators: these are scripts that populate the docs with Nitro variables, contract addresses, and Docker images.
There were stale ones and the need for new ones, as the docs repo grows and references an increasing amount of code.
It fixes some legacy generator and adds its own **Contract addresses ** that generate the Chain-info contract-address partial from
@arbitrum/sdk+ a small data file for non-SDK contracts. Also adds the missingRollupCreator/TokenBridgeCreatortables and corrects a stale Arbitrum Sepolia Rollup address.Some Nitro version tags and Docker data will now be pulled into the directory regularly
Unrelated: it also fixes very old ts compile errors, which will allow us to use Husky's pre-commit hook again.