Repository navigation
chore(renovate): stop offering npm-pin updates and guard the pin #1278
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| // renovate.json's constraints.npm sets the npm version Renovate writes | ||
| // dashboard/package-lock.json with. It must match the npm CI runs, which is | ||
| // the one bundled with Node, so a Node major can move it. Renovate doesn't | ||
| // offer updates to the pin, so this fails the Node major PR's dashboard | ||
| // build until someone raises it. Enforced in CI only, so a local build on | ||
| // another npm isn't blocked. | ||
| import { readFileSync } from "node:fs"; | ||
|
|
||
| const running = (process.env.npm_config_user_agent ?? "").match( | ||
| /\bnpm\/(\d+)\.\d+\.\d+/, | ||
| ); | ||
| if (!process.env.CI || !running) process.exit(0); | ||
|
|
||
| const config = JSON.parse( | ||
| readFileSync(new URL("../../renovate.json", import.meta.url), "utf8"), | ||
| ); | ||
| const pin = config.constraints?.npm ?? ""; | ||
| const version = running[0].slice(4); | ||
|
|
||
| if (pin.match(/\d+/)?.[0] !== running[1]) { | ||
| console.error( | ||
| `renovate.json has constraints.npm "${pin}", but CI runs npm ${version}. ` + | ||
| `Set constraints.npm to "^${version}" in this pull request.`, | ||
| ); | ||
| process.exit(1); | ||
| } | ||
| console.log(`renovate.json constraints.npm "${pin}" matches npm ${version}.`); | ||
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
correctness (low, advisory):
CIis also set inpublish-to-pages.yml, which runsnpm run build(.github/workflows/publish-to-pages.yml:127-130) every 2 hours onmain. Both workflows float onnode-version: '26'(publish-to-pages.yml:118,dashboard-build.yml:41). A Node minor can bring a new npm major without any Renovate PR; Node 18.19 moved npm 9 to 10. If that happens, the scheduled publish stops deploying the dashboard, and there is no PR where the pin could be raised. Today a lock written by npm 11 would still install under npm 12, so the only cost is a stale pin. Suggest enforcing only on PR and merge-queue builds, where a person can fix it:If you take this, also update SKILL.md point 12 ("it only enforces when
CIis set").