Merge pull request backstage#28375 from jvmdc/patch-2

Fix checkpoint example in "Writing custom actions"
RoadieHQ · Jan 28, 2025 · 90f73c6 · 90f73c6
2 parents e59af9c + 91af968
commit 90f73c6
Showing 1 changed file with 11 additions and 8 deletions.
diff --git a/docs/features/software-templates/writing-custom-actions.md b/docs/features/software-templates/writing-custom-actions.md
@@ -263,14 +263,17 @@ Idempotent action could be achieved via the usage of checkpoints.
 Example:
 
 ```ts title="plugins/my-company-scaffolder-actions-plugin/src/vendor/my-custom-action.ts"
-const res = await ctx.checkpoint?.('create.projects', async () => {
-  const projectStgId = createStagingProjectId();
-  const projectProId = createProductionProjectId();
-
-  return {
-    projectStgId,
-    projectProId,
-  };
+const res = await ctx.checkpoint?.({
+  key: 'create.projects',
+  fn: async () => {
+    const projectStgId = createStagingProjectId();
+    const projectProId = createProductionProjectId();
+
+    return {
+      projectStgId,
+      projectProId,
+    };
+  },
 });
 ```