@backstage/plugin-scaffolder-backend-module-github 0.4.1-next.0 → 0.4.1-next.1

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @backstage/plugin-scaffolder-backend-module-github
 
+## 0.4.1-next.1
+
+### Patch Changes
+
+- d21d307: Added examples for github:environment:create action and improve its test cases
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.7.1-next.1
+  - @backstage/backend-common@0.23.4-next.1
+  - @backstage/integration@1.14.0-next.0
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/plugin-scaffolder-node@0.4.9-next.1
+
 ## 0.4.1-next.0
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -1649,6 +1649,208 @@ const examples$4 = [
         }
       ]
     })
+  },
+  {
+    description: "Create a GitHub Environment with Custom Tag Policies",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "github:environment:create",
+          name: "Create Environment",
+          input: {
+            repoUrl: "github.com?repo=repository&owner=owner",
+            name: "envname",
+            customTagPolicyNames: ["release/*/*", "v*.*.*"]
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitHub Environment with Both Branch and Tag Policies",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "github:environment:create",
+          name: "Create Environment",
+          input: {
+            repoUrl: "github.com?repo=repository&owner=owner",
+            name: "envname",
+            deploymentBranchPolicy: {
+              protected_branches: false,
+              custom_branch_policies: true
+            },
+            customBranchPolicyNames: ["feature/*", "hotfix/*"],
+            customTagPolicyNames: ["release/*", "v*"]
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitHub Environment with Full Configuration",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "github:environment:create",
+          name: "Create Environment",
+          input: {
+            repoUrl: "github.com?repo=repository&owner=owner",
+            name: "envname",
+            deploymentBranchPolicy: {
+              protected_branches: false,
+              custom_branch_policies: true
+            },
+            customBranchPolicyNames: ["dev/*", "test/*"],
+            customTagPolicyNames: ["v1.*", "v2.*"],
+            environmentVariables: {
+              API_KEY: "123456789",
+              NODE_ENV: "production"
+            },
+            secrets: {
+              DATABASE_URL: "supersecretdatabaseurl",
+              API_SECRET: "supersecretapisecret"
+            },
+            token: "ghp_abcdef1234567890"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitHub Environment with Only Token Authentication",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "github:environment:create",
+          name: "Create Environment",
+          input: {
+            repoUrl: "github.com?repo=repository&owner=owner",
+            name: "envname",
+            token: "ghp_abcdef1234567890"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitHub Environment with No Deployment Policies",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "github:environment:create",
+          name: "Create Environment",
+          input: {
+            repoUrl: "github.com?repo=repository&owner=owner",
+            name: "envname",
+            deploymentBranchPolicy: null
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitHub Environment with Custom Branch and Tag Policies",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "github:environment:create",
+          name: "Create Environment",
+          input: {
+            repoUrl: "github.com?repo=repository&owner=owner",
+            name: "envname",
+            deploymentBranchPolicy: {
+              protected_branches: false,
+              custom_branch_policies: true
+            },
+            customBranchPolicyNames: ["release/*", "hotfix/*"],
+            customTagPolicyNames: ["v*", "release-*"]
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitHub Environment with Environment Variables Only",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "github:environment:create",
+          name: "Create Environment",
+          input: {
+            repoUrl: "github.com?repo=repository&owner=owner",
+            name: "envname",
+            environmentVariables: {
+              VAR1: "value1",
+              VAR2: "value2"
+            }
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitHub Environment with Deployment Secrets Only",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "github:environment:create",
+          name: "Create Environment",
+          input: {
+            repoUrl: "github.com?repo=repository&owner=owner",
+            name: "envname",
+            secrets: {
+              SECRET1: "secretvalue1",
+              SECRET2: "secretvalue2"
+            }
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitHub Environment with Deployment Branch Policy and Token",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "github:environment:create",
+          name: "Create Environment",
+          input: {
+            repoUrl: "github.com?repo=repository&owner=owner",
+            name: "envname",
+            deploymentBranchPolicy: {
+              protected_branches: true,
+              custom_branch_policies: false
+            },
+            token: "ghp_abcdef1234567890"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitHub Environment with Environment Variables, Secrets, and Token",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "github:environment:create",
+          name: "Create Environment",
+          input: {
+            repoUrl: "github.com?repo=repository&owner=owner",
+            name: "envname",
+            environmentVariables: {
+              VAR1: "value1",
+              VAR2: "value2"
+            },
+            secrets: {
+              SECRET1: "secretvalue1",
+              SECRET2: "secretvalue2"
+            },
+            token: "ghp_abcdef1234567890"
+          }
+        }
+      ]
+    })
   }
 ];