Merge pull request #23451 from Thomgrus/feat/add-gitlab-issue-iid-output

feat(plugin-scaffolder-backend-module-gitlab): add gitlab issue iid i…

.changeset/modern-wasps-wink.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-scaffolder-backend-module-gitlab': minor
+---
+
+Output the `iid` as `issuesIid` from the `gitlab:issues:create` action

plugins/scaffolder-backend-module-gitlab/api-report.md

@@ -48,6 +48,7 @@ export const createGitlabIssueAction: (options: {
   {
     issueUrl: string;
     issueId: number;
+    issueIid: number;
   }
 >;
 

plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabIssueAction.test.ts

@@ -70,6 +70,7 @@ describe('gitlab:issues:create', () => {
 
     mockGitlabClient.Issues.create.mockResolvedValue({
       id: 42,
+      iid: 1,
       web_url: 'https://gitlab.com/hangar18-/issues/42',
     });
 
@@ -97,6 +98,7 @@ describe('gitlab:issues:create', () => {
     );
 
     expect(mockContext.output).toHaveBeenCalledWith('issueId', 42);
+    expect(mockContext.output).toHaveBeenCalledWith('issueIid', 1);
     expect(mockContext.output).toHaveBeenCalledWith(
       'issueUrl',
       'https://gitlab.com/hangar18-/issues/42',
@@ -116,6 +118,7 @@ describe('gitlab:issues:create', () => {
 
     mockGitlabClient.Issues.create.mockResolvedValue({
       id: 42,
+      iid: 1,
       web_url: 'https://gitlab.com/hangar18-/issues/42',
     });
 
@@ -143,6 +146,7 @@ describe('gitlab:issues:create', () => {
     );
 
     expect(mockContext.output).toHaveBeenCalledWith('issueId', 42);
+    expect(mockContext.output).toHaveBeenCalledWith('issueIid', 1);
     expect(mockContext.output).toHaveBeenCalledWith(
       'issueUrl',
       'https://gitlab.com/hangar18-/issues/42',
@@ -168,6 +172,7 @@ describe('gitlab:issues:create', () => {
 
     mockGitlabClient.Issues.create.mockResolvedValue({
       id: 42,
+      iid: 1,
       web_url: 'https://gitlab.com/hangar18-/issues/42',
     });
 
@@ -196,6 +201,7 @@ describe('gitlab:issues:create', () => {
     );
 
     expect(mockContext.output).toHaveBeenCalledWith('issueId', 42);
+    expect(mockContext.output).toHaveBeenCalledWith('issueIid', 1);
     expect(mockContext.output).toHaveBeenCalledWith(
       'issueUrl',
       'https://gitlab.com/hangar18-/issues/42',

plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabIssueAction.ts

@@ -102,6 +102,7 @@ const issueInputProperties = z.object({
 const issueOutputProperties = z.object({
   issueUrl: z.string({ description: 'Issue Url' }),
   issueId: z.number({ description: 'Issue Id' }),
+  issueIid: z.number({ description: 'Issue Iid' }),
 });
 
 /**
@@ -194,6 +195,7 @@ export const createGitlabIssueAction = (options: {
 
         ctx.output('issueId', response.id);
         ctx.output('issueUrl', response.web_url);
+        ctx.output('issueIid', response.iid);
       } catch (error: any) {
         if (error instanceof z.ZodError) {
           // Handling Zod validation errors