paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 36 Packages Projects Releases Wiki Activity

feat(plugin-scaffolder-backend-module-gitlab): add gitlab issue iid in the output

Browse Source 
Signed-off-by: Thomas GRUSON <thomgrus@gmail.com>
This commit is contained in:
Thomas GRUSON
2024-03-08 12:23:24 +01:00
parent 3f0b8d8a3c
commit 6bfb7b1b5a
3 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/modern-wasps-wink.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-scaffolder-backend-module-gitlab': minor
---
Add a mapping from gitlab create issue API to also output the issue iid (id scoped to the gitlab project) in the output of the scaffolder.
plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabIssueAction.test.ts
+6
View File
@@ -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
+2
View File
@@ -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