chore: Add example templates for ArgoCD actions#8704
Conversation
New actions were added to the ArgoCD plugin. We should also have some example templates users can reference. Signed-off-by: Bryan Ramos <bramos@redhat.com>
CryptoRodeo
requested review from
a team,
Eswaraiahsapram,
HusneShabbir,
caugello,
christoph-jerolimov,
ciiay,
debsmita1,
divyanshiGupta,
djanickova,
dzemanov,
its-mitesh-kumar,
jrichter1,
karthikjeeyar,
lokanandaprabhu and
rohitkrai03
as code owners
Changed Packages
|
There was a problem hiding this comment.
Pull request overview
Adds user-facing examples for the new ArgoCD Actions API operations introduced in #8539, making it easier for users to invoke these actions via Scaffolder templates (and via raw actionId payload examples).
Changes:
- Added 4 new Scaffolder
Templateexamples for the new ArgoCD read actions (find/get/list/revision-details). - Added 4 new “action invocation” YAML examples demonstrating minimal/full inputs and expected outputs.
- Registered the new templates in the ArgoCD workspace catalog locations and added a changeset.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| workspaces/argocd/examples/templates/argocd-find-applications.yaml | New scaffolder template example for finding apps across instances |
| workspaces/argocd/examples/templates/argocd-get-application.yaml | New scaffolder template example for fetching a single application |
| workspaces/argocd/examples/templates/argocd-get-revision-details.yaml | New scaffolder template example for fetching revision metadata |
| workspaces/argocd/examples/templates/argocd-list-applications.yaml | New scaffolder template example for listing apps on an instance |
| workspaces/argocd/examples/02-argocd-find-applications-action.yaml | New raw action invocation example for find-applications |
| workspaces/argocd/examples/03-argocd-get-application-action.yaml | New raw action invocation example for get-application |
| workspaces/argocd/examples/04-argocd-get-revision-details-action.yaml | New raw action invocation example for get-revision-details |
| workspaces/argocd/examples/05-argocd-list-applications-action.yaml | New raw action invocation example for list-applications |
| workspaces/argocd/app-config.yaml | Imports the new templates into the workspace catalog |
| workspaces/argocd/.changeset/stale-steaks-doubt.md | Changeset for publishing the examples update |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Bryan Ramos <bramos@redhat.com>
Signed-off-by: Bryan Ramos <bramos@redhat.com>
|
I just noticed that some actions are registered as This PR can focus on just adding example templates. |
Signed-off-by: Bryan Ramos <bramos@redhat.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Bryan Ramos <bramos@redhat.com>
|
I created #8820 to update the action names. This PR can focus on the example templates. |
|
Heads up @Eswaraiahsapram , @karthikjeeyar . These might be good for testing the new actions. |
dzemanov
left a comment
dzemanov
left a comment
There was a problem hiding this comment.
@CryptoRodeo thank you for the PR!
I have tested locally that templates work:
It would be great if we could add examples similarly to this action.examples.ts and register, so they show up in Backstage.
I haven't checked though if and how it can be done for actions registered by actionsRegistry
|
@dzemanov Thank you for testing and reviewing. If time allows I will take a look soon on adding those examples you referenced |
Hey, I just made a Pull Request!
New actions were added to the ArgoCD plugin. We should also have some example templates users can reference.
Related to #8539
Get ArgoCD Application
get-argocd-application-demo.mp4
Get ArgoCD Revision Details
get-argocd-revision-details.mp4
List ArgoCD Applications
list-argocd-apps-demo.mp4
Find ArgoCD Applications
Screencast.From.2026-04-17.16-26-16.mp4
✔️ Checklist
Signed-off-byline in the message. (more info)