feat(environments): custom branch policies support type ('branch', 't…

…ag') (#910)
repository-settings · Jun 28, 2024 · 7c25368 · 7c25368
1 parent d8387f9
commit 7c25368
Show file tree

Hide file tree

Showing 4 changed files with 343 additions and 12 deletions.
diff --git a/docs/plugins/environments.md b/docs/plugins/environments.md
@@ -29,4 +29,8 @@ environments:
       custom_branches:
         - main
         - dev/*
+        - name: release/*
+          type: branch
+        - name: v*
+          type: tag
 ```
diff --git a/lib/plugins/environments.js b/lib/plugins/environments.js
@@ -38,7 +38,9 @@ function deploymentBranchPolicyToString (attrs) {
     return JSON.stringify(
       shouldUseProtectedBranches(attrs.protected_branches, attrs.custom_branches)
         ? { protected_branches: true }
-        : { custom_branches: attrs.custom_branches.sort() }
+        : {
+            custom_branches: attrs.custom_branches.sort((a, b) => JSON.stringify(a).localeCompare(JSON.stringify(b)))
+          }
     )
   }
 }
@@ -66,6 +68,14 @@ module.exports = class Environments extends Diffable {
       // Force all names to lowercase to avoid comparison issues.
       this.entries.forEach(environment => {
         environment.name = environment.name.toLowerCase()
+        if (environment.deployment_branch_policy && environment.deployment_branch_policy.custom_branches) {
+          environment.deployment_branch_policy.custom_branches = environment.deployment_branch_policy.custom_branches.map(
+            rule => ({
+              name: rule.name || rule,
+              type: rule.type || 'branch'
+            })
+          )
+        }
       })
     }
   }
@@ -88,7 +98,10 @@ module.exports = class Environments extends Diffable {
               environment.name
             )
             environment.deployment_branch_policy = {
-              custom_branches: branchPolicies.map(_ => _.name)
+              custom_branches: branchPolicies.map(_ => ({
+                name: _.name,
+                type: _.type
+              }))
             }
           } else {
             environment.deployment_branch_policy = {
@@ -147,12 +160,13 @@ module.exports = class Environments extends Diffable {
 
     if (attrs.deployment_branch_policy && attrs.deployment_branch_policy.custom_branches) {
       await Promise.all(
-        attrs.deployment_branch_policy.custom_branches.map(name =>
+        attrs.deployment_branch_policy.custom_branches.map(rule =>
           this.github.request('POST /repos/:org/:repo/environments/:environment_name/deployment-branch-policies', {
             org: this.repo.owner,
             repo: this.repo.repo,
             environment_name: attrs.name,
-            name
+            name: rule.name,
+            type: rule.type
           })
         )
       )

diff --git a/test/integration/features/step_definitions/environments-steps.mjs b/test/integration/features/step_definitions/environments-steps.mjs
@@ -75,7 +75,11 @@ Given('an environment exists with a {string} branches deployment branch policy',
   )
 
   if (policyType === 'custom') {
-    this.customBranches = any.listOf(() => ({ name: any.word(), id: any.integer() }))
+    this.customBranches = any.listOf(() => ({
+      name: any.word(),
+      id: any.integer(),
+      type: any.fromList(['branch'])
+    }))
     this.removedDeploymentBranchPolicyIds = {}
 
     this.server.use(
@@ -373,7 +377,12 @@ Given('an environment is defined in the config with a protected branches deploym
 
 Given('an environment is defined in the config with a custom branches deployment branch policy', async function () {
   this.environmentName = any.word()
-  this.customBranchNames = any.listOf(any.word)
+  this.customBranches = any.listOf(() => ({
+    name: any.word(),
+    id: any.integer(),
+    type: any.fromList(['branch'])
+  }))
+  this.customBranchNames = this.customBranches.map(branch => branch.name)
   this.createdDeploymentBranchPolicyNames = {}
 
   this.server.use(
@@ -388,7 +397,7 @@ Given('an environment is defined in the config with a custom branches deployment
               environments: [
                 {
                   name: this.environmentName,
-                  deployment_branch_policy: { protected_branches: false, custom_branches: this.customBranchNames }
+                  deployment_branch_policy: { protected_branches: false, custom_branches: this.customBranches }
                 }
               ]
             })