From c3d158689cea45c84c3009494cd88a70001c84ed Mon Sep 17 00:00:00 2001
From: Kyle McCormick <kyle@axim.org>
Date: Fri, 7 Jun 2024 10:06:15 -0400
Subject: [PATCH] build: switch renovate.json to JSON5 for comment support
 (#34944)

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 https://github.com/openedx/edx-platform/issues/34940
---
 .github/{renovate.json => renovate.json5} | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)
 rename .github/{renovate.json => renovate.json5} (59%)

diff --git a/.github/renovate.json b/.github/renovate.json5
similarity index 59%
rename from .github/renovate.json
rename to .github/renovate.json5
index a0ee80098567..4365ab9be58f 100644
--- a/.github/renovate.json
+++ b/.github/renovate.json5
@@ -1,3 +1,4 @@
+// This file is written in "JSON5" (https://json5.org/) so that we can use comments.
 {
   "extends": [
     "config:base",
@@ -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"]