fix(build-schema): enhance schema dereferencing with GitHub API spec

Author: madkoo

lib/plugins/branches.js

@@ -64,7 +64,7 @@ module.exports = class Branches extends ErrorStash {
               const params = Object.assign({}, p)
               return this.github.rest.repos.getBranchProtection(params).then((result) => {
                 const mergeDeep = new MergeDeep(this.log, this.github, ignorableFields)
-                const changes = mergeDeep.compareDeep({ branch: { protection: this.reformatAndReturnBranchProtection(result.data) } }, { branch: { protection: Overrides.removeOverrides(overrides, branch.protection, result.data) } })
+                const changes = mergeDeep.compareDeep({ branch: { protection: this.reformatAndReturnBranchProtection(structuredClone(result.data)) } }, { branch: { protection: Overrides.removeOverrides(overrides, branch.protection, result.data) } })
                 const results = { msg: `Followings changes will be applied to the branch protection for ${params.branch.name} branch`, additions: changes.additions, modifications: changes.modifications, deletions: changes.deletions }
                 this.log.debug(`Result of compareDeep = ${results}`)
 
@@ -81,7 +81,7 @@ module.exports = class Branches extends ErrorStash {
                   resArray.push(new NopCommand(this.constructor.name, this.repo, null, results))
                 }
 
-                Object.assign(params, requiredBranchProtectionDefaults, branch.protection, { headers: previewHeaders })
+                Object.assign(params, requiredBranchProtectionDefaults, this.reformatAndReturnBranchProtection(structuredClone(result.data)), Overrides.removeOverrides(overrides, branch.protection, result.data), { headers: previewHeaders })
 
                 if (this.nop) {
                   resArray.push(new NopCommand(this.constructor.name, this.repo, this.github.rest.repos.updateBranchProtection.endpoint(params), 'Add Branch Protection'))
@@ -131,6 +131,29 @@ module.exports = class Branches extends ErrorStash {
       protection.required_linear_history = protection.required_linear_history && protection.required_linear_history.enabled
       protection.enforce_admins = protection.enforce_admins && protection.enforce_admins.enabled
       protection.required_signatures = protection.required_signatures && protection.required_signatures.enabled
+      protection.allow_force_pushes = protection.allow_force_pushes && protection.allow_force_pushes.enabled
+      protection.block_creations = protection.block_creations && protection.block_creations.enabled
+      protection.lock_branch = protection.lock_branch && protection.lock_branch.enabled
+      protection.allow_fork_syncing = protection.allow_fork_syncing && protection.allow_fork_syncing.enabled
+      if (protection.restrictions) {
+        delete protection.restrictions.url
+        protection.restrictions.users = Array.isArray(protection.restrictions.users)
+          ? protection.restrictions.users.map(user => user.login || user)
+          : []
+        protection.restrictions.teams = Array.isArray(protection.restrictions.teams)
+          ? protection.restrictions.teams.map(team => team.slug || team)
+          : []
+        protection.restrictions.apps = Array.isArray(protection.restrictions.apps)
+          ? protection.restrictions.apps.map(app => app.slug || app)
+          : []
+      }
+      if (protection.required_status_checks) {
+        delete protection.required_status_checks.url
+        delete protection.required_status_checks.contexts_url
+        if (Array.isArray(protection.required_status_checks.contexts) && protection.required_status_checks.contexts.length === 0) {
+          delete protection.required_status_checks.contexts
+        }
+      }
       if (protection.required_pull_request_reviews && !protection.required_pull_request_reviews.bypass_pull_request_allowances) {
         protection.required_pull_request_reviews.bypass_pull_request_allowances = { apps: [], teams: [], users: [] }
       }

lib/plugins/rulesets.js

@@ -7,7 +7,7 @@ const overrides = {
   'required_status_checks': {
     'action': 'delete',
     'parents': 3,
-    'type': 'dict'
+    'type': 'array'
   },
 }
 

schema/dereferenced/repos.json

@@ -145,6 +145,15 @@
                               "TEAM",
                               "ROLE"
                             ]
+                          },
+                          "mode": {
+                            "type": "string",
+                            "description": "The bypass mode for the reviewer",
+                            "enum": [
+                              "ALWAYS",
+                              "EXEMPT"
+                            ],
+                            "default": "ALWAYS"
                           }
                         }
                       }
@@ -957,6 +966,15 @@
                               "TEAM",
                               "ROLE"
                             ]
+                          },
+                          "mode": {
+                            "type": "string",
+                            "description": "The bypass mode for the reviewer",
+                            "enum": [
+                              "ALWAYS",
+                              "EXEMPT"
+                            ],
+                            "default": "ALWAYS"
                           }
                         }
                       }