feat: Add support for tags in deployment branch policies

Author: JakubBiel

docs/github-settings/6. deployment-environments.md

@@ -27,10 +27,14 @@ environments:
       - type: User
         id: 139262123
     deployment_branch_policy:
-      protected_branches: true
-      custom_branch_policies: false
+      protected_branches: false
+      custom_branch_policies:
+        - names: ['main','dev']
+          type: branch
+        - names: ['v*.*.*']
+          type: tag
     deployment_protection_rules:
-      - app_id: 25112  
+      - app_id: 25112
     variables:
       - name: MY_AWESOME_VAR
         value: '845705'
@@ -43,7 +47,8 @@ environments:
 >[!TIP]
 >GitHub's API documentation defines these inputs and types:
 >1. [Create or update an environment](https://docs.github.com/en/rest/deployments/environments?apiVersion=2022-11-28#create-or-update-an-environment)
->2. [Create an environment variable](https://docs.github.com/en/rest/actions/variables?apiVersion=2022-11-28#create-an-environment-variable)
+>2. [Create a deployment branch policy](https://docs.github.com/en/rest/deployments/branch-policies?apiVersion=2022-11-28#create-a-deployment-branch-policy)
+>3. [Create an environment variable](https://docs.github.com/en/rest/actions/variables?apiVersion=2022-11-28#create-an-environment-variable)
 
 <table>
 <tr><td>
@@ -126,11 +131,11 @@ environments:
 
 <details><summary>Properties of <code>deployment_branch_policy</code></summary>
 <br>
-<p>&emsp;<code>protected_branches</code><span style="color:gray;">&emsp;<i>string</i>&emsp;</span><span style="color:orange;">${\text{\color{orange}Required}}$</span></p>
-<p>&emsp;&emsp;Whether only branches with branch protection rules can deploy<br>&emsp;&emsp;to this environment. If <code>protected_branches</code> is <code>true</code>,<br>&emsp;&emsp;<code>custom_branch_policies</code> must be <code>false</code>; if <code>protected_branches</code><br>&emsp;&emsp;is <code>false</code>, <code>custom_branch_policies</code> must be <code>true</code>.</p>
+<p>&emsp;<code>protected_branches</code><span style="color:gray;">&emsp;<i>boolean</i>&emsp;</span><span style="color:orange;">${\text{\color{orange}Required}}$</span></p>
+<p>&emsp;&emsp;Whether only branches with branch protection rules can deploy<br>&emsp;&emsp;to this environment. If <code>protected_branches</code> is <code>true</code>,<br>&emsp;&emsp;<code>custom_branch_policies</code> must be <code>false</code>; if <code>protected_branches</code><br>&emsp;&emsp;is <code>false</code>, <code>custom_branch_policies</code> must be an object.</p>
 
-<p>&emsp;<code>id</code><span style="color:gray;">&emsp;<i>integer</i>&emsp;</span></p>
-<p>&emsp;&emsp;Whether only branches that match the specified name patterns<br>&emsp;&emsp;can deploy to this environment. If <code>custom_branch_policies</code><br>&emsp;&emsp;is <code>true</code>, <code>protected_branches</code> must be <code>false</code>; if<br>&emsp;&emsp;<code>custom_branch_policies</code> is <code>false</code>, <code>protected_branches</code><br>&emsp;&emsp;must be <code>true</code>.</p>
+<p>&emsp;<code>custom_branch_policies</code><span style="color:gray;">&emsp;<i>boolean or object</i>&emsp;</span></p>
+<p>&emsp;&emsp;Whether only branches that match the specified name patterns<br>&emsp;&emsp;can deploy to this environment. If <code>custom_branch_policies</code><br>&emsp;&emsp;is <code>false</code>, <code>protected_branches</code> must be <code>true</code>; if<br>&emsp;&emsp;<code>custom_branch_policies</code> is an object, <code>protected_branches</code><br>&emsp;&emsp;must be <code>false</code>.</p>
 
 </details>
 
@@ -142,8 +147,12 @@ environments:
   - name: production
     ...
     deployment_branch_policy:
-      protected_branches: true
-      custom_branch_policies: false
+      protected_branches: false
+      custom_branch_policies:
+        - names: ['main','dev']
+          type: branch
+        - names: ['v*.*.*']
+          type: tag
 ...
 ```
 

lib/plugins/environments.js

@@ -14,6 +14,16 @@ module.exports = class Environments extends Diffable {
             variable.name = variable.name.toLowerCase()
           })
         }
+        // Expand custom_branch_policies to match GitHub schema.
+        if (environment.deployment_branch_policy && environment.deployment_branch_policy.custom_branch_policies) {
+          const policies = []
+          environment.deployment_branch_policy.custom_branch_policies.forEach(policy => {
+            policy.names.forEach(name => {
+              policies.push({ name: name, type: policy.type })
+            })
+          })
+          environment.deployment_branch_policy.custom_branch_policies = policies
+        }
       })
     }
   }
@@ -52,7 +62,8 @@ module.exports = class Environments extends Diffable {
                 repo: this.repo.repo,
                 environment_name: environment.name
               })).data.branch_policies.map(policy => ({
-                name: policy.name
+                name: policy.name,
+                type: policy.type
               }))
             },
         variables: (await this.github.request('GET /repos/:org/:repo/environments/:environment_name/variables', {
@@ -93,11 +104,11 @@ module.exports = class Environments extends Diffable {
 
     let existingCustomBranchPolicies = existing.deployment_branch_policy === null ? null : existing.deployment_branch_policy.custom_branch_policies
     if (typeof (existingCustomBranchPolicies) === 'object' && existingCustomBranchPolicies !== null) {
-      existingCustomBranchPolicies = existingCustomBranchPolicies.sort()
+      existingCustomBranchPolicies = existingCustomBranchPolicies.sort((x1, x2) => x1.name.localeCompare(x2.name))
     }
     let attrsCustomBranchPolicies = attrs.deployment_branch_policy === null ? null : attrs.deployment_branch_policy.custom_branch_policies
     if (typeof (attrsCustomBranchPolicies) === 'object' && attrsCustomBranchPolicies !== null) {
-      attrsCustomBranchPolicies = attrsCustomBranchPolicies.sort()
+      attrsCustomBranchPolicies = attrsCustomBranchPolicies.sort((x1, x2) => x1.name.localeCompare(x2.name))
     }
     let deploymentBranchPolicy
     if (existing.deployment_branch_policy === attrs.deployment_branch_policy) {
@@ -163,7 +174,8 @@ module.exports = class Environments extends Diffable {
         await this.nopifyRequest(
           'POST /repos/:org/:repo/environments/:environment_name/deployment-branch-policies', {
             ...baseRequestOptions,
-            name: policy
+            name: policy.name,
+            type: policy.type
           }, 'Create deployment branch policy')
       }
     }
@@ -256,7 +268,8 @@ module.exports = class Environments extends Diffable {
         await this.nopifyRequest(
           'POST /repos/:org/:repo/environments/:environment_name/deployment-branch-policies', {
             ...baseRequestOptions,
-            name: policy.name
+            name: policy.name,
+            type: policy.type
           }, 'Create deployment branch policy'
         )
       }

test/unit/lib/plugins/environments.test.js

@@ -302,8 +302,14 @@ describe('Environments Plugin test suite', () => {
           deployment_branch_policy: {
             protected_branches: false,
             custom_branch_policies: [
-              'master',
-              'dev'
+              {
+                names: ['main','dev'],
+                type: 'branch'
+              },
+              {
+                names: ['v*.*.*'],
+                type: 'tag'
+              }
             ]
           }
         }
@@ -342,13 +348,22 @@ describe('Environments Plugin test suite', () => {
           org,
           repo,
           environment_name: environmentName,
-          name: 'master'
+          name: 'main',
+          type: 'branch'
+        }))
+        expect(github.request).toHaveBeenCalledWith('POST /repos/:org/:repo/environments/:environment_name/deployment-branch-policies', expect.objectContaining({
+          org,
+          repo,
+          environment_name: environmentName,
+          name: 'dev',
+          type: 'branch'
         }))
         expect(github.request).toHaveBeenCalledWith('POST /repos/:org/:repo/environments/:environment_name/deployment-branch-policies', expect.objectContaining({
           org,
           repo,
           environment_name: environmentName,
-          name: 'dev'
+          name: 'v*.*.*',
+          type: 'tag'
         }))
       })
     })
@@ -753,8 +768,14 @@ describe('Environments Plugin test suite', () => {
           deployment_branch_policy: {
             protected_branches: false,
             custom_branch_policies: [
-              'master',
-              'dev'
+              {
+                names: ['main','dev'],
+                type: 'branch'
+              },
+              {
+                names: ['v*.*.*'],
+                type: 'tag'
+              }
             ]
           }
         },
@@ -890,14 +911,24 @@ describe('Environments Plugin test suite', () => {
           org,
           repo,
           environment_name: 'deployment-branch-policy-custom_environment',
-          name: 'master'
+          name: 'main',
+          type: 'branch'
         }))
 
         expect(github.request).toHaveBeenCalledWith('POST /repos/:org/:repo/environments/:environment_name/deployment-branch-policies', expect.objectContaining({
           org,
           repo,
           environment_name: 'deployment-branch-policy-custom_environment',
-          name: 'dev'
+          name: 'dev',
+          type: 'branch'
+        }))
+
+        expect(github.request).toHaveBeenCalledWith('POST /repos/:org/:repo/environments/:environment_name/deployment-branch-policies', expect.objectContaining({
+          org,
+          repo,
+          environment_name: 'deployment-branch-policy-custom_environment',
+          name: 'v*.*.*',
+          type: 'tag'
         }))
 
         expect(github.request).toHaveBeenCalledWith('POST /repos/:org/:repo/environments/:environment_name/variables', expect.objectContaining({
@@ -957,8 +988,14 @@ describe('Environments Plugin test suite', () => {
           deployment_branch_policy: {
             protected_branches: false,
             custom_branch_policies: [
-              'master',
-              'dev'
+              {
+                names: ['main','dev'],
+                type: 'branch'
+              },
+              {
+                names: ['v*.*.*'],
+                type: 'tag'
+              }
             ]
           }
         },
@@ -1012,8 +1049,14 @@ describe('Environments Plugin test suite', () => {
           deployment_branch_policy: {
             protected_branches: false,
             custom_branch_policies: [
-              'master',
-              'dev'
+              {
+                names: ['main','dev'],
+                type: 'branch'
+              },
+              {
+                names: ['v*.*.*'],
+                type: 'tag'
+              }
             ]
           }
         },
@@ -1149,14 +1192,24 @@ describe('Environments Plugin test suite', () => {
           org,
           repo,
           environment_name: 'deployment-branch-policy-custom_environment',
-          name: 'master'
+          name: 'main',
+          type: 'branch'
+        }))
+
+        expect(github.request).toHaveBeenCalledWith('POST /repos/:org/:repo/environments/:environment_name/deployment-branch-policies', expect.objectContaining({
+          org,
+          repo,
+          environment_name: 'deployment-branch-policy-custom_environment',
+          name: 'dev',
+          type: 'branch'
         }))
 
         expect(github.request).toHaveBeenCalledWith('POST /repos/:org/:repo/environments/:environment_name/deployment-branch-policies', expect.objectContaining({
           org,
           repo,
           environment_name: 'deployment-branch-policy-custom_environment',
-          name: 'dev'
+          name: 'v*.*.*',
+          type: 'tag'
         }))
 
         expect(github.request).toHaveBeenCalledWith('POST /repos/:org/:repo/environments/:environment_name/variables', expect.objectContaining({