From 890dfe614af5d28af2119ac23264dc7372a0a209 Mon Sep 17 00:00:00 2001
From: djamaile <rdjamaile@gmail.com>
Date: Thu, 9 Jun 2022 14:46:01 +0200
Subject: [PATCH] chore: give alternative to deprecated projectId

Signed-off-by: djamaile <rdjamaile@gmail.com>
---
 plugins/scaffolder-backend/api-report.md                    | 4 ----
 .../actions/builtin/publish/gitlabMergeRequest.ts           | 6 +++---
 2 files changed, 3 insertions(+), 7 deletions(-)

diff --git a/plugins/scaffolder-backend/api-report.md b/plugins/scaffolder-backend/api-report.md
index fbb071cd51..707b8e62ba 100644
--- a/plugins/scaffolder-backend/api-report.md
+++ b/plugins/scaffolder-backend/api-report.md
@@ -710,8 +710,4 @@ export class TemplateActionRegistry {
 
 // @public (undocumented)
 export type TemplateFilter = (...args: JsonValue[]) => JsonValue | undefined;
-
-// Warnings were encountered during analysis:
-//
-// src/scaffolder/actions/builtin/publish/gitlabMergeRequest.d.ts:16:9 - (tsdoc-missing-deprecation-message) The @deprecated block must include a deprecation message, e.g. describing the recommended alternative
 ```
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlabMergeRequest.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlabMergeRequest.ts
index 07c094cba9..c5dd41f807 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlabMergeRequest.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlabMergeRequest.ts
@@ -40,7 +40,7 @@ export const createPublishGitlabMergeRequestAction = (options: {
     branchName: string;
     targetPath: string;
     token?: string;
-    /** @deprecated */
+    /** @deprecated Use projectPath instead */
     projectid?: string;
   }>({
     id: 'publish:gitlab:merge-request',
@@ -54,7 +54,7 @@ export const createPublishGitlabMergeRequestAction = (options: {
             title: 'Repository Location',
             description: `Accepts the format 'gitlab.com/group_name/project_name' where 'project_name' is the repository name and 'group_name' is a group or username`,
           },
-          /** @deprecated */
+          /** @deprecated Use projectPath instead */
           projectid: {
             type: 'string',
             title: 'projectid',
@@ -185,7 +185,7 @@ export const createPublishGitlabMergeRequestAction = (options: {
         ).then((mergeRequest: { web_url: string }) => {
           return mergeRequest.web_url;
         });
-        /** @deprecated */
+        /** @deprecated Use projectPath instead */
         ctx.output('projectid', projectPath);
         ctx.output('projectPath', projectPath);
         ctx.output('mergeRequestUrl', mergeRequestUrl);