chore: Add example templates for ArgoCD actions

workspaces/argocd/.changeset/rude-rocks-play.md

@@ -0,0 +1,5 @@
+---
+'@backstage-community/plugin-argocd-backend': patch
+---
+
+Add example templates for ArgoCD plugin actions

workspaces/argocd/app-config.yaml

@@ -107,6 +107,26 @@ catalog:
       rules:
         - allow: [Template]
 
+    - type: file
+      target: ../../examples/templates/argocd-find-applications.yaml
+      rules:
+        - allow: [Template]
+
+    - type: file
+      target: ../../examples/templates/argocd-get-application.yaml
+      rules:
+        - allow: [Template]
+
+    - type: file
+      target: ../../examples/templates/argocd-get-revision-details.yaml
+      rules:
+        - allow: [Template]
+
+    - type: file
+      target: ../../examples/templates/argocd-list-applications.yaml
+      rules:
+        - allow: [Template]
+
     # Local example organizational data
     - type: file
       target: ../../examples/org.yaml

workspaces/argocd/examples/02-argocd-find-applications-action.yaml

@@ -0,0 +1,40 @@
+# ArgoCD Find Applications Action
+#
+# Action ID: backstage-community-argocd:argocd:find-applications
+#
+# This action is automatically registered by the @backstage-community/plugin-argocd-backend
+# plugin via the Backstage Actions API. No additional setup is required beyond
+# installing the backend plugin.
+#
+# Prerequisites:
+#   - ArgoCD backend plugin installed and configured
+#   - ArgoCD instance(s) configured in app-config.yaml under argocd.appLocatorMethods
+
+---
+# Minimal example (required fields only)
+actionId: backstage-community-argocd:argocd:find-applications
+input:
+  appName: my-service
+
+---
+# Full example (all fields)
+actionId: backstage-community-argocd:argocd:find-applications
+input:
+  appName: my-service
+  project: my-project # Filter by ArgoCD project name
+  appNamespace: argocd # Filter by application namespace
+
+# Expected output:
+#   instances:
+#     - instanceName: production
+#       instanceUrl: https://argocd.example.com
+#       applications:
+#         - name: my-service
+#           namespace: argocd
+#           project: my-project
+#           syncStatus: Synced
+#           healthStatus: Healthy
+#           revision: abc123def
+#           destination:
+#             server: https://kubernetes.default.svc
+#             namespace: my-namespace

workspaces/argocd/examples/03-argocd-get-application-action.yaml

@@ -0,0 +1,42 @@
+# ArgoCD Get Application Action
+#
+# Action ID: backstage-community-argocd:argocd:get-application
+#
+# This action is automatically registered by the @backstage-community/plugin-argocd-backend
+# plugin via the Backstage Actions API. No additional setup is required beyond
+# installing the backend plugin.
+#
+# Prerequisites:
+#   - ArgoCD backend plugin installed and configured
+#   - ArgoCD instance(s) configured in app-config.yaml under argocd.appLocatorMethods
+
+---
+# Minimal example (required fields only)
+actionId: backstage-community-argocd:argocd:get-application
+input:
+  instanceName: local
+  appName: my-service
+
+---
+# Full example (all fields)
+actionId: backstage-community-argocd:argocd:get-application
+input:
+  instanceName: local
+  appName: my-service
+  appNamespace: argocd # Namespace of the application
+  project: my-project # ArgoCD project name
+
+# Expected output:
+#   name: my-service
+#   namespace: argocd
+#   project: my-project
+#   syncStatus: Synced
+#   healthStatus: Healthy
+#   revision: abc123def
+#   operationPhase: Succeeded
+#   operationMessage: successfully synced
+#   destination:
+#     server: https://kubernetes.default.svc
+#     namespace: my-namespace
+#   resourcesCount: 5
+#   historyCount: 3

workspaces/argocd/examples/04-argocd-get-revision-details-action.yaml

@@ -0,0 +1,34 @@
+# ArgoCD Get Revision Details Action
+#
+# Action ID: backstage-community-argocd:argocd:get-revision-details
+#
+# This action is automatically registered by the @backstage-community/plugin-argocd-backend
+# plugin via the Backstage Actions API. No additional setup is required beyond
+# installing the backend plugin.
+#
+# Prerequisites:
+#   - ArgoCD backend plugin installed and configured
+#   - ArgoCD instance(s) configured in app-config.yaml under argocd.appLocatorMethods
+
+---
+# Minimal example (required fields only)
+actionId: backstage-community-argocd:argocd:get-revision-details
+input:
+  instanceName: local
+  appName: my-service
+  revisionID: abc123def456
+
+---
+# Full example (all fields)
+actionId: backstage-community-argocd:argocd:get-revision-details
+input:
+  instanceName: local
+  appName: my-service
+  revisionID: abc123def456
+  appNamespace: argocd # Namespace of the application
+
+# Expected output:
+#   author: Jane Developer
+#   date: 2026-04-15T10:30:00Z
+#   message: "feat: add new deployment config"
+#   revisionID: abc123def456

workspaces/argocd/examples/05-argocd-list-applications-action.yaml

@@ -0,0 +1,48 @@
+# ArgoCD List Applications Action
+#
+# Action ID: backstage-community-argocd:argocd:list-applications
+#
+# This action is automatically registered by the @backstage-community/plugin-argocd-backend
+# plugin via the Backstage Actions API. No additional setup is required beyond
+# installing the backend plugin.
+#
+# Prerequisites:
+#   - ArgoCD backend plugin installed and configured
+#   - ArgoCD instance(s) configured in app-config.yaml under argocd.appLocatorMethods
+
+---
+# Minimal example (required fields only)
+actionId: backstage-community-argocd:argocd:list-applications
+input:
+  instanceName: local
+
+---
+# Full example (all fields)
+actionId: backstage-community-argocd:argocd:list-applications
+input:
+  instanceName: local
+  selector: app.kubernetes.io/part-of=my-app # Label selector to filter applications
+  project: my-project # Filter by ArgoCD project name
+  appNamespace: argocd # Filter by application namespace
+
+# Expected output:
+#   totalCount: 2
+#   applications:
+#     - name: my-service
+#       namespace: argocd
+#       project: my-project
+#       syncStatus: Synced
+#       healthStatus: Healthy
+#       revision: abc123def
+#       destination:
+#         server: https://kubernetes.default.svc
+#         namespace: my-namespace
+#     - name: my-other-service
+#       namespace: argocd
+#       project: my-project
+#       syncStatus: OutOfSync
+#       healthStatus: Degraded
+#       revision: def456ghi
+#       destination:
+#         server: https://kubernetes.default.svc
+#         namespace: other-namespace

workspaces/argocd/examples/templates/argocd-find-applications.yaml

@@ -0,0 +1,45 @@
+apiVersion: scaffolder.backstage.io/v1beta3
+kind: Template
+metadata:
+  name: argocd-find-applications
+  title: Find ArgoCD Applications
+  description: Find all ArgoCD applications across all configured instances by application name
+  tags:
+    - argocd
+    - deployment
+    - kubernetes
+spec:
+  owner: group:default/infrastructure
+  type: deployment
+  parameters:
+    - title: Find ArgoCD Applications
+      required:
+        - appName
+      properties:
+        appName:
+          title: Application Name
+          type: string
+          description: The ArgoCD application name to search for
+        project:
+          title: Project Name
+          type: string
+          description: Filter by ArgoCD project name
+        appNamespace:
+          title: Application Namespace
+          type: string
+          description: Filter by application namespace
+  steps:
+    - id: find-applications
+      name: Find ArgoCD Applications
+      action: backstage-community-argocd:argocd:find-applications
+      input:
+        appName: ${{ parameters.appName }}
+        project: ${{ parameters.project }}
+        appNamespace: ${{ parameters.appNamespace }}
+  output:
+    text:
+      - title: Found Instances
+        content: |
+          ```json
+          ${{ steps['find-applications'].output.instances | dump }}
+          ```

workspaces/argocd/examples/templates/argocd-get-application.yaml

@@ -0,0 +1,52 @@
+apiVersion: scaffolder.backstage.io/v1beta3
+kind: Template
+metadata:
+  name: argocd-get-application
+  title: Get ArgoCD Application
+  description: Get full details of a specific ArgoCD application from a named instance
+  tags:
+    - argocd
+    - deployment
+    - kubernetes
+spec:
+  owner: group:default/infrastructure
+  type: deployment
+  parameters:
+    - title: ArgoCD Application Details
+      required:
+        - instanceName
+        - appName
+      properties:
+        instanceName:
+          title: ArgoCD Instance
+          type: string
+          description: Name of the ArgoCD instance as configured in argocd.appLocatorMethods[].instances
+        appName:
+          title: Application Name
+          type: string
+          description: The ArgoCD application name
+        appNamespace:
+          title: Application Namespace
+          type: string
+          description: Namespace of the application
+        project:
+          title: Project Name
+          type: string
+          description: ArgoCD project name
+  steps:
+    - id: get-application
+      name: Get ArgoCD Application
+      action: backstage-community-argocd:argocd:get-application
+      input:
+        instanceName: ${{ parameters.instanceName }}
+        appName: ${{ parameters.appName }}
+        appNamespace: ${{ parameters.appNamespace }}
+        project: ${{ parameters.project }}
+  output:
+    text:
+      - title: Application Status
+        content: |
+          **Name:** ${{ steps['get-application'].output.name }}
+          **Sync:** ${{ steps['get-application'].output.syncStatus }}
+          **Health:** ${{ steps['get-application'].output.healthStatus }}
+          **Resources:** ${{ steps['get-application'].output.resourcesCount }}

workspaces/argocd/examples/templates/argocd-get-revision-details.yaml

@@ -0,0 +1,52 @@
+apiVersion: scaffolder.backstage.io/v1beta3
+kind: Template
+metadata:
+  name: argocd-get-revision-details
+  title: Get ArgoCD Revision Details
+  description: Fetch the Git commit metadata for a specific revision of an ArgoCD application deployment
+  tags:
+    - argocd
+    - deployment
+    - kubernetes
+spec:
+  owner: group:default/infrastructure
+  type: deployment
+  parameters:
+    - title: Revision Details
+      required:
+        - instanceName
+        - appName
+        - revisionID
+      properties:
+        instanceName:
+          title: ArgoCD Instance
+          type: string
+          description: Name of the ArgoCD instance
+        appName:
+          title: Application Name
+          type: string
+          description: The ArgoCD application name
+        revisionID:
+          title: Revision ID
+          type: string
+          description: Git commit SHA or tag to get details for
+        appNamespace:
+          title: Application Namespace
+          type: string
+          description: Namespace of the application
+  steps:
+    - id: get-revision-details
+      name: Get Revision Details
+      action: backstage-community-argocd:argocd:get-revision-details
+      input:
+        instanceName: ${{ parameters.instanceName }}
+        appName: ${{ parameters.appName }}
+        revisionID: ${{ parameters.revisionID }}
+        appNamespace: ${{ parameters.appNamespace }}
+  output:
+    text:
+      - title: Revision Info
+        content: |
+          **Author:** ${{ steps['get-revision-details'].output.author }}
+          **Date:** ${{ steps['get-revision-details'].output.date }}
+          **Message:** ${{ steps['get-revision-details'].output.message }}