@stackgenhq/backstage-plugin-stackgen-backend 0.3.6-beta.1

package/templates/full-infra-setup.yaml

@@ -0,0 +1,156 @@
+# =============================================================================
+# Full Infrastructure Setup
+# =============================================================================
+# The most comprehensive template. Creates a project with Git config, an
+# AppStack with a resource pack, and then provisions production & staging
+# environments — each with per-environment Terraform variables and S3
+# state backends.
+#
+# This template demonstrates:
+#   • Git configuration for IaC source control
+#   • Resource pack provisioning
+#   • Environment creation with Terraform variables
+#   • S3 remote state backend configuration per environment
+# =============================================================================
+apiVersion: scaffolder.backstage.io/v1beta3
+kind: Template
+metadata:
+    name: stackgen-full-setup
+    title: Full Infrastructure Setup
+    description: Create a project, AppStack, and environments with Terraform variables and S3 state backends — all in one flow
+spec:
+    owner: user:guest
+    type: service
+    parameters:
+        - title: Configuration
+          required:
+              - projectName
+              - serviceName
+              - repoUrl
+          properties:
+              projectName:
+                  type: string
+                  title: Project Name
+              serviceName:
+                  type: string
+                  title: Service Name
+              repoUrl:
+                  type: string
+                  title: Git Repository URL
+                  default: "https://github.com/org/repo.git"
+
+    steps:
+        # Step 1: Create project with Git config (no environments here — those
+        # are created by setStateBackend below with state backends attached)
+        - id: createProject
+          name: Create Project with Git Config
+          action: stackGen:createProject
+          input:
+              project:
+                  name: ${{ parameters.projectName }}
+                  description: "Project created via Backstage — Full Infrastructure Setup"
+                  gitConfig:
+                      name: "default-git-config"
+                      type: "git"
+                      parameters:
+                          scmType: "GITHUB"
+                          repoUrl: ${{ parameters.repoUrl }}
+                          targetBranch: "main"
+                          path: "infrastructure"
+                      default: true
+
+        # Step 2: Create AppStack with resource pack + standalone S3 + custom module
+        - id: createAppStack
+          name: Create AppStack with Resources
+          action: stackGen:createAppStack
+          input:
+              appstack:
+                  name: ${{ parameters.serviceName }}
+                  cloudProvider: "aws"
+                  teamId: ${{ steps.createProject.output.teamId }}
+                  resources:
+                      # Resource pack — a pre-configured bundle of resources
+                      - resourceType: resourcePack
+                        resourcePackId: 03c4d48d-0b01-4110-80de-9ac351545329
+                      # Standalone resource — an individual S3 bucket
+                      - resourceType: aws_s3
+                        name: my-extra-s3-bucket
+                      # Custom module — a user-authored Terraform module via templateId
+                      - resourceType: vibe-coded-module
+                        iacType: Terraform
+                        templateId: 68a391f8-0e6b-41fb-b993-75905e9f211e
+
+        # Step 3: Create 'production' environment with TF variables + S3 backend
+        - id: setBackendProd
+          name: Create Production Environment with S3 Backend
+          action: stackGen:setStateBackend
+          input:
+              teamId: ${{ steps.createProject.output.teamId }}
+              topologyId: ${{ steps.createAppStack.output.topologyId }}
+              environmentName: "production"
+              color: "#FF0000"
+              variables:
+                  - name: "region"
+                    type: "string"
+                    defaultValueJson: '"us-east-1"'
+                    description: "AWS deployment region"
+                  - name: "instance_count"
+                    type: "number"
+                    defaultValueJson: "3"
+                    description: "Number of instances"
+                  - name: "environment"
+                    type: "string"
+                    defaultValueJson: '"production"'
+                    description: "Environment name"
+                  - name: "enable_monitoring"
+                    type: "bool"
+                    defaultValueJson: "true"
+                    description: "Enable CloudWatch monitoring"
+              stateBackend:
+                  type: S3
+                  config:
+                      bucket: "bucket-1"
+                      encrypt: "true"
+                      key: "production"
+                      region: "us-west-1"
+                      dynamodb_table: "DynamoDBTable"
+
+        # Step 4: Create 'staging' environment with TF variables + S3 backend
+        - id: setBackendStaging
+          name: Create Staging Environment with S3 Backend
+          action: stackGen:setStateBackend
+          input:
+              teamId: ${{ steps.createProject.output.teamId }}
+              topologyId: ${{ steps.createAppStack.output.topologyId }}
+              environmentName: "staging"
+              color: "#FFA500"
+              variables:
+                  - name: "region"
+                    type: "string"
+                    defaultValueJson: '"us-west-2"'
+                    description: "AWS deployment region"
+                  - name: "instance_count"
+                    type: "number"
+                    defaultValueJson: "1"
+                    description: "Number of instances"
+                  - name: "environment"
+                    type: "string"
+                    defaultValueJson: '"staging"'
+                    description: "Environment name"
+                  - name: "enable_monitoring"
+                    type: "bool"
+                    defaultValueJson: "false"
+                    description: "Enable CloudWatch monitoring"
+              stateBackend:
+                  type: S3
+                  config:
+                      bucket: "bucket-1"
+                      encrypt: "true"
+                      key: "staging"
+                      region: "us-west-1"
+                      dynamodb_table: "DynamoDBTable"
+
+    output:
+        links:
+            - title: "View AppStack in StackGen"
+              url: ${{ steps.createAppStack.output.appStackURL }}

package/templates/git_export_exporter_multi_scm.yaml

@@ -0,0 +1,123 @@
+# Example: push IaC using stackGen:exportToGit (single step — resolves topology,
+# picks or bootstraps git exporter config, runs stack-exporter export).
+apiVersion: scaffolder.backstage.io/v1beta3
+kind: Template
+metadata:
+  name: stackgen-git-export-exporter
+  title: Push IaC via StackGen exporter
+  description: >-
+    Export an existing AppStack to Git via stack-exporter. Pick team and AppStack from the dropdowns;
+    topology and exporter appstackId are resolved via appcd /appstacks when omitted. If no git exporter
+    config exists yet, the action bootstraps one from the project default template (or pass gitConfig
+    on the action). Optional explicit topologyId.
+spec:
+  owner: user:guest
+  type: service
+  parameters:
+    - title: Stack context
+      required:
+        - teamId
+        - appstackName
+      properties:
+        teamId:
+          type: string
+          title: Team / project
+          ui:field: TeamSelect
+        appstackName:
+          type: string
+          title: AppStack
+          ui:field: AppStackSelect
+          ui:options:
+            teamId: teamId
+        existingExporterConfigId:
+          type: string
+          title: Existing exporter config
+          description: >-
+            Optional. If this AppStack already has configs, pick one (auto-selected when there is only one).
+            If none exist and you leave this blank, a config is created from the project default.
+            To define a new config in the template instead, pass gitConfig on the stackGen:exportToGit step.
+          ui:field: ExporterGitConfigSelect
+          ui:options:
+            teamId: teamId
+            appstackName: appstackName
+
+    - title: Git export options
+      properties:
+        baseBranch:
+          type: string
+          title: Base branch
+          description: >-
+            Branch to base the change on. Prefills from the selected exporter
+            config target branch; leave blank to use the config default.
+          ui:field: ExporterBaseBranch
+          ui:options:
+            teamId: teamId
+            configId: existingExporterConfigId
+        pushBranch:
+          type: object
+          title: Push branch
+          description: >-
+            Branch StackGen pushes the generated IaC to. Prefills from the latest
+            export history when available; leaving the suggestion unchanged reuses
+            that branch (use_same_branch).
+          ui:field: ExporterPushBranch
+          ui:options:
+            teamId: teamId
+            appstackName: appstackName
+          properties:
+            branch:
+              type: string
+            useSameBranch:
+              type: boolean
+        createPr:
+          type: boolean
+          title: Create pull request
+          description: >-
+            When on, StackGen opens a pull request against the base branch. When off,
+            changes are committed directly to the base branch without a pull request.
+          default: true
+
+    - title: Pull request
+      required:
+        - prTitle
+        - commitMessage
+      properties:
+        prTitle:
+          type: string
+          title: Pull request title
+          default: StackGen IaC export
+        commitMessage:
+          type: string
+          title: Commit message
+          default: Export IaC from StackGen
+
+  steps:
+    - id: exportToGit
+      name: Export AppStack to Git
+      action: stackGen:exportToGit
+      input:
+        teamId: ${{ parameters.teamId }}
+        appstackName: ${{ parameters.appstackName }}
+        configId: ${{ parameters.existingExporterConfigId }}
+        # First-class git export controls (parity with the StackGen UI). Empty base/push
+        # branches fall back to the git config defaults; createPr defaults to true.
+        # useSameBranch is true when the push branch was suggested from history and left as-is.
+        baseBranch: ${{ parameters.baseBranch }}
+        pushBranch: ${{ parameters.pushBranch.branch }}
+        useSameBranch: ${{ parameters.pushBranch.useSameBranch }}
+        createPr: ${{ parameters.createPr }}
+        overrides:
+          - key: pr_title
+            value: ${{ parameters.prTitle }}
+          - key: commit_msg
+            value: ${{ parameters.commitMessage }}
+
+  output:
+    links:
+      # Present when a pull request is created (createPr on). For commit-only exports,
+      # use steps.exportToGit.output.committedBranch / notes instead.
+      - title: View pull request
+        url: ${{ steps.exportToGit.output.pullRequestUrl }}
+    text:
+      - title: Export result
+        content: ${{ steps.exportToGit.output.notes }}

package/templates/project-advanced.yaml

@@ -0,0 +1,77 @@
+# =============================================================================
+# Create Project (Advanced)
+# =============================================================================
+# Creates a fully configured StackGen project with:
+#   • Git configuration (GitHub, main branch, user-provided repo URL)
+#   • Two environments: dev and production
+#   • A root-level variable "region" (default: us-east-1)
+#   • An environment override setting region to us-west-2 for production
+#
+# This is a reference template showing how to pass Git configs, environment
+# templates, variables, and variable overrides to stackGen:createProject.
+# =============================================================================
+apiVersion: scaffolder.backstage.io/v1beta3
+kind: Template
+metadata:
+    name: stackgen-project-advanced
+    title: Create Project (Advanced)
+    description: Create a project with Git integration, environments, variables, and per-environment overrides
+spec:
+    owner: user:guest
+    type: service
+    parameters:
+        - title: Project Information
+          required:
+              - projectName
+              - repoUrl
+          properties:
+              projectName:
+                  title: Project Name
+                  type: string
+                  description: "Name of the project to create"
+                  ui:autofocus: true
+              repoUrl:
+                  title: Repository URL
+                  type: string
+                  description: "Git repository URL for the project"
+                  default: "https://github.com/org/repo.git"
+
+    steps:
+        - id: create-project
+          name: Create StackGen Project
+          action: stackGen:createProject
+          input:
+              project:
+                  name: ${{ parameters.projectName }}
+                  description: "Project created via Backstage with Advanced Config"
+                  gitConfig:
+                      name: "default-git-config"
+                      type: "git"
+                      parameters:
+                          scmType: "GITHUB"
+                          repoUrl: ${{ parameters.repoUrl }}
+                          targetBranch: "main"
+                      default: true
+                  environmentConfig:
+                      name: "default-env-config"
+                      environmentTemplates:
+                          - name: "dev"
+                            color: "#1cbb9b"
+                          - name: "production"
+                            color: "#FF0000"
+                      # Root-level variable with a default value
+                      variables:
+                          - name: "region"
+                            type: "string"
+                            defaultValueJson: '"us-east-1"'
+                            description: "AWS region for deployment"
+                      # Environment-specific override: production uses us-west-2
+                      variableOverrides:
+                          - variableName: "region"
+                            environmentTemplateName: "production"
+                            valueJson: '"us-west-2"'
+
+    output:
+        links:
+            - title: "View Created Project"
+              url: "https://main.dev.stackgen.com/orgs/${{ steps['create-project'].output.projectId }}"

package/templates/project-basic.yaml

@@ -0,0 +1,39 @@
+# =============================================================================
+# Create Project (Basic)
+# =============================================================================
+# Creates an empty project (team) in StackGen with just a name. No Git config,
+# environments, or resources — a blank slate for adding AppStacks later.
+# =============================================================================
+apiVersion: scaffolder.backstage.io/v1beta3
+kind: Template
+metadata:
+    name: stackgen-project-basic
+    title: Create Project (Basic)
+    description: Create an empty StackGen project — a blank starting point for adding AppStacks and resources
+spec:
+    owner: user:guest
+    type: service
+    parameters:
+        - title: Project Information
+          required:
+              - projectName
+          properties:
+              projectName:
+                  title: Project Name
+                  type: string
+                  description: "Name of the project to create"
+                  ui:autofocus: true
+
+    steps:
+        - id: create-project
+          name: Create StackGen Project
+          action: stackGen:createProject
+          input:
+              project:
+                  name: ${{ parameters.projectName }}
+                  description: "Project created via Backstage"
+
+    output:
+        links:
+            - title: "View Created Project"
+              url: "https://main.dev.stackgen.com/orgs/${{ steps['create-project'].output.projectId }}"

package/templates/project-with-members.yaml

@@ -0,0 +1,86 @@
+# =============================================================================
+# Create Project with Members
+# =============================================================================
+# Creates a StackGen project and assigns selected users / groups as members.
+# Demonstrates UserGroupSelect + stackGen:assignProjectMembers.
+# =============================================================================
+apiVersion: scaffolder.backstage.io/v1beta3
+kind: Template
+metadata:
+  name: stackgen-project-with-members
+  title: Create Project with Members
+  description: Create a StackGen project and add users or groups as project members
+  tags:
+    - stackgen
+    - project
+spec:
+  owner: user:guest
+  type: service
+  parameters:
+    - title: Project
+      required:
+        - projectName
+      properties:
+        projectName:
+          title: Project Name
+          type: string
+          description: Name of the StackGen project (team) to create
+          ui:autofocus: true
+        projectDescription:
+          title: Description
+          type: string
+          default: Project created via Backstage with member assignments
+        members:
+          title: Project Members
+          type: array
+          description: Users and/or groups to add to the new project
+          ui:field: UserGroupSelect
+          items:
+            type: object
+            required:
+              - type
+              - id
+            properties:
+              type:
+                type: string
+                enum: [user, group]
+              id:
+                type: string
+              label:
+                type: string
+        roleId:
+          title: Project role
+          type: string
+          description: >
+            Role applied to every selected user/group. Pick Admin, DevOps, or
+            Developer, or paste a custom role UUID. Leave blank to use the
+            action default (developer).
+          ui:field: RoleSelect
+          default: "00000000-0000-0000-0000-000000000004"
+
+  steps:
+    - id: create-project
+      name: Create StackGen Project
+      action: stackGen:createProject
+      input:
+        project:
+          name: ${{ parameters.projectName }}
+          description: ${{ parameters.projectDescription }}
+
+    - id: assign-members
+      name: Assign Project Members
+      action: stackGen:assignProjectMembers
+      input:
+        projectId: ${{ steps['create-project'].output.teamId }}
+        members: ${{ parameters.members }}
+        roleId: ${{ parameters.roleId }}
+
+  output:
+    links:
+      - title: View Created Project
+        url: ${{ steps['create-project'].output.projectURL }}
+    text:
+      - title: Assigned users
+        content: ${{ steps['assign-members'].output.assignedUsersText }}
+      - title: Assigned groups
+        content: ${{ steps['assign-members'].output.assignedGroupsText }}