Skip to content

Commit

Permalink
build: switch renovate.json to JSON5 for comment support (#34944)
Browse files Browse the repository at this point in the history
Allows us to use comments to explain why we pin (ignore) certain deps.

Renovate docs ref: https://docs.renovatebot.com/configuration-options/#configuration-options

Closes #34940
  • Loading branch information
kdmccormick authored Jun 7, 2024
1 parent ead0468 commit c3d1586
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions .github/renovate.json → .github/renovate.json5
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// This file is written in "JSON5" (https://json5.org/) so that we can use comments.
{
"extends": [
"config:base",
Expand Down Expand Up @@ -28,11 +29,13 @@
"automerge": true
}
],
"ignoreDeps": ["moment-timezone"],
"__Open_edX_ignoreDeps_reasons__": {
"__note__": "When you add a package to ignoreDeps, add a comment to this object, using the package name as the key, and the comment as the value.",
"moment-timezone": "Broke legacy programs dashboard, which is deprecated and soon to be removed. See https://github.com/openedx/edx-platform/pull/34928"
},
// When adding an ignoreDep, please include a reason and a public link that we can use to follow up and ensure
// that the ignoreDep is removed.
"ignoreDeps": [
// Latest moment-timezone version broke the legacy programs dashboard, which is deprecated and soon to be removed.
// https://github.com/openedx/edx-platform/pull/34928"
"moment-timezone",
],
"timezone": "America/New_York",
"prConcurrentLimit": 3,
"enabledManagers": ["npm"]
Expand Down

0 comments on commit c3d1586

Please sign in to comment.