From e61ed0901c9fcd7e2473e314e35e73196025300a Mon Sep 17 00:00:00 2001 From: Elaine Mattos Date: Tue, 19 Dec 2023 19:03:14 +0100 Subject: [PATCH] fix: add public decorator Signed-off-by: Elaine Mattos --- .../scaffolder-backend-module-gitlab/api-report.md | 6 ++---- .../src/actions/createGitlabIssueAction.ts | 13 ++++++------- 2 files changed, 8 insertions(+), 11 deletions(-) diff --git a/plugins/scaffolder-backend-module-gitlab/api-report.md b/plugins/scaffolder-backend-module-gitlab/api-report.md index 908ea43f7f..7f94daf6c9 100644 --- a/plugins/scaffolder-backend-module-gitlab/api-report.md +++ b/plugins/scaffolder-backend-module-gitlab/api-report.md @@ -22,9 +22,7 @@ export const createGitlabGroupEnsureExistsAction: (options: { } >; -// Warning: (ae-missing-release-tag) "createGitlabIssueAction" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// -// @public (undocumented) +// @public export const createGitlabIssueAction: (options: { integrations: ScmIntegrationRegistry; }) => TemplateAction< @@ -169,7 +167,7 @@ export const createPublishGitlabMergeRequestAction: (options: { sourcePath?: string | undefined; targetPath?: string | undefined; token?: string | undefined; - commitAction?: 'update' | 'create' | 'delete' | undefined; + commitAction?: 'update' | 'delete' | 'create' | undefined; projectid?: string | undefined; removeSourceBranch?: boolean | undefined; assignee?: string | undefined; diff --git a/plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabIssueAction.ts b/plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabIssueAction.ts index 62dc94d14a..e92344fb90 100644 --- a/plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabIssueAction.ts +++ b/plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabIssueAction.ts @@ -23,13 +23,6 @@ import { z } from 'zod'; import { checkEpicScope, convertDate, getClient, parseRepoUrl } from '../util'; import { Gitlab, CreateIssueOptions, IssueSchema } from '@gitbeaker/rest'; -/** - * Creates a `gitlab:issues:create` Scaffolder action. - * - * @param {} - Templating configuration. - * @public - */ - const enumIssueType = { ISSUE: 'issue', INCIDENT: 'incident', @@ -124,6 +117,12 @@ const issueOutputProperties = z.object({ issueId: z.number({ description: 'Issue Id' }), }); +/** + * Creates a `gitlab:issues:create` Scaffolder action. + * + * @param options - Templating configuration. + * @public + */ export const createGitlabIssueAction = (options: { integrations: ScmIntegrationRegistry; }) => {