feat: update labels when config changes

lib/modules/platform/azure/index.spec.ts

@@ -1410,7 +1410,8 @@ describe('modules/platform/azure/index', () => {
     it('returns updated pr body', () => {
       const prBody =
         '\n---\n\n - [ ] <!-- rebase-check --> rebase\n<!--renovate-config-hash:-->' +
-        'plus also [a link](https://github.com/foo/bar/issues/5)';
+        'plus also [a link](https://github.com/foo/bar/issues/5)' +
+        `<!--labels:aSmofwineo-->`;
       expect(azure.massageMarkdown(prBody)).toBe(
         'plus also [a link](https://github.com/foo/bar/issues/5)'
       );

lib/modules/platform/azure/index.ts

@@ -812,7 +812,8 @@ export function massageMarkdown(input: string): string {
       'renaming the PR to start with "rebase!"'
     )
     .replace(regEx(`\n---\n\n.*?<!-- rebase-check -->.*?\n`), '')
-    .replace(regEx(/<!--renovate-(?:debug|config-hash):.*?-->/g), '');
+    .replace(regEx(/<!--renovate-(?:debug|config-hash):.*?-->/g), '')
+    .replace(regEx(/<!--labels:.*?-->/g), '');
 }
 
 /* istanbul ignore next */

lib/modules/platform/bitbucket-server/__snapshots__/index.spec.ts.snap

@@ -198,6 +198,7 @@ exports[`modules/platform/bitbucket-server/index endpoint with no path massageMa
 
 Empty comment.
 
+
 Followed by some information.
 "
 `;
@@ -402,6 +403,7 @@ exports[`modules/platform/bitbucket-server/index endpoint with path massageMarkd
 
 Empty comment.
 
+
 Followed by some information.
 "
 `;

lib/modules/platform/bitbucket-server/index.spec.ts

@@ -1743,6 +1743,7 @@ describe('modules/platform/bitbucket-server/index', () => {
 <!---->
 Empty comment.
 <!-- This is another comment -->
+<!--labels:aSwedlninfa-->
 Followed by some information.
 <!-- followed by some more comments -->`);
           expect(prBody).toMatchSnapshot();

lib/modules/platform/bitbucket-server/index.ts

@@ -983,5 +983,6 @@ export function massageMarkdown(input: string): string {
     .replace(regEx(/<\/?summary>/g), '**')
     .replace(regEx(/<\/?details>/g), '')
     .replace(regEx(`\n---\n\n.*?<!-- rebase-check -->.*?(\n|$)`), '')
-    .replace(regEx('<!--.*?-->', 'g'), '');
+    .replace(regEx('<!--.*?-->', 'g'), '')
+    .replace(regEx(/<!--labels:.*?-->/g), '');
 }

lib/modules/platform/bitbucket/index.spec.ts

@@ -1370,8 +1370,8 @@ describe('modules/platform/bitbucket/index', () => {
       const prBody =
         '<details><summary>foo</summary>\n<blockquote>\n\n<details><summary>text</summary>' +
         '\n---\n\n - [ ] <!-- rebase-check --> rebase\n<!--renovate-config-hash:-->' +
-        '\n\n</details>\n\n</blockquote>\n</details>';
-
+        '\n\n</details>\n\n</blockquote>\n</details>' +
+        `<!--labels:aSdwerfwefmk1-->`;
       expect(bitbucket.massageMarkdown(prBody)).toMatchSnapshot();
     });
   });

lib/modules/platform/bitbucket/index.ts

@@ -564,7 +564,8 @@ export function massageMarkdown(input: string): string {
     .replace(regEx(/<\/?(details|blockquote)>/g), '')
     .replace(regEx(`\n---\n\n.*?<!-- rebase-check -->.*?\n`), '')
     .replace(regEx(/\]\(\.\.\/pull\//g), '](../../pull-requests/')
-    .replace(regEx(/<!--renovate-(?:debug|config-hash):.*?-->/g), '');
+    .replace(regEx(/<!--renovate-(?:debug|config-hash):.*?-->/g), '')
+    .replace(regEx(/<!--labels:.*?-->/g), '');
 }
 
 export async function ensureIssue({

lib/modules/platform/codecommit/index.spec.ts

@@ -54,7 +54,8 @@ describe('modules/platform/codecommit/index', () => {
 
   it('validates massageMarkdown functionality', () => {
     const newStr = codeCommit.massageMarkdown(
-      '<details><summary>foo</summary>bar</details>text<details>\n<!--renovate-debug:hiddenmessage123-->'
+      '<details><summary>foo</summary>bar</details>text<details>\n<!--renovate-debug:hiddenmessage123-->' +
+        '<!--labels:aSdwerfwefmk1-->'
     );
     expect(newStr).toBe(
       '**foo**bartext\n[//]: # (<!--renovate-debug:hiddenmessage123-->)'

lib/modules/platform/codecommit/index.ts

@@ -320,7 +320,8 @@ export function massageMarkdown(input: string): string {
     .replace(
       regEx(/(?<hiddenComment><!--renovate-(?:debug|config-hash):.*?-->)/g),
       '[//]: # ($<hiddenComment>)'
-    );
+    )
+    .replace(regEx(/<!--labels:.*?-->/g), '');
 }
 
 export async function getJsonFile(

lib/modules/platform/gitea/gitea-helper.spec.ts

@@ -2,6 +2,7 @@ import * as httpMock from '../../../../test/http-mock';
 import { setBaseUrl } from '../../../util/http/gitea';
 import { toBase64 } from '../../../util/string';
 import {
+  assignLabel,
   closeIssue,
   closePR,
   createComment,
@@ -602,6 +603,22 @@ describe('modules/platform/gitea/gitea-helper', () => {
     });
   });
 
+  describe('assignLabel', () => {
+    it('should call /api/v1/repos/[repo]/issues/[issue]/labels endpoint', async () => {
+      httpMock
+        .scope(baseUrl)
+        .patch(`/repos/${mockRepo.full_name}/issues/${mockIssue.number}/labels`)
+        .reply(200);
+
+      const res = await assignLabel(
+        mockRepo.full_name,
+        mockIssue.number,
+        mockLabel.id
+      );
+      expect(res).toBeUndefined();
+    });
+  });
+
   describe('createComment', () => {
     it('should call /api/v1/repos/[repo]/issues/[issue]/comments endpoint', async () => {
       httpMock

lib/modules/platform/gitea/gitea-helper.ts

@@ -306,6 +306,21 @@ export async function unassignLabel(
   await giteaHttp.deleteJson(url, options);
 }
 
+export async function assignLabel(
+  repoPath: string,
+  issue: number,
+  label: number,
+  options?: GiteaHttpOptions
+): Promise<void> {
+  const url = `${API_PATH}/repos/${repoPath}/issues/${issue}/labels`;
+  await giteaHttp.patchJson(url, {
+    ...options,
+    body: {
+      labels: [label],
+    },
+  });
+}
+
 export async function createComment(
   repoPath: string,
   issue: number,

lib/modules/platform/gitea/index.spec.ts

@@ -1290,6 +1290,58 @@ describe('modules/platform/gitea/index', () => {
         state: 'closed',
       });
     });
+
+    it('should add new labels', async () => {
+      helper.getRepoLabels.mockResolvedValueOnce([
+        { id: 1, name: 'old_label', description: 'its a me', color: '#000000' },
+        {
+          id: 2,
+          name: 'new_label',
+          description: 'labelario',
+          color: '#ffffff',
+        },
+      ]);
+      helper.getOrgLabels.mockResolvedValueOnce([]);
+      helper.searchPRs.mockResolvedValueOnce(mockPRs);
+      await initFakeRepo();
+      await gitea.updatePr({
+        number: 1,
+        prTitle: 'New Title',
+        prBody: 'New Body',
+        state: 'closed',
+        labels: ['new_label'],
+      });
+
+      expect(helper.updatePR).toHaveBeenCalledWith(mockRepo.full_name, 1, {
+        title: 'New Title',
+        body: 'New Body',
+        state: 'closed',
+        labels: [2],
+      });
+    });
+
+    it('should remove old labels', async () => {
+      helper.getRepoLabels.mockResolvedValueOnce([
+        { id: 1, name: 'old_label', description: 'its a me', color: '#000000' },
+      ]);
+      helper.getOrgLabels.mockResolvedValueOnce([]);
+      helper.searchPRs.mockResolvedValueOnce(mockPRs);
+      await initFakeRepo();
+      await gitea.updatePr({
+        number: 1,
+        prTitle: 'New Title',
+        prBody: 'New Body',
+        state: 'closed',
+        labels: [],
+      });
+
+      expect(helper.updatePR).toHaveBeenCalledWith(mockRepo.full_name, 1, {
+        title: 'New Title',
+        body: 'New Body',
+        state: 'closed',
+        labels: [],
+      });
+    });
   });
 
   describe('mergePr', () => {

lib/modules/platform/gitea/index.ts

@@ -622,11 +622,13 @@ const platform: Platform = {
     number,
     prTitle,
     prBody: body,
+    labels,
     state,
     targetBranch,
   }: UpdatePrConfig): Promise<void> {
     let title = prTitle;
-    if ((await getPrList()).find((pr) => pr.number === number)?.isDraft) {
+    const pr = (await getPrList()).find((pr) => pr.number === number);
+    if (pr?.isDraft) {
       title = DRAFT_PREFIX + title;
     }
 
@@ -639,6 +641,13 @@ const platform: Platform = {
       prUpdateParams.base = targetBranch;
     }
 
+    // no need to do extra call for removing labels as gitea API replaces labels array
+    if (Array.isArray(labels)) {
+      prUpdateParams.labels = (
+        await Promise.all(labels.map(lookupLabelByName))
+      ).filter(is.number);
+    }
+
     await helper.updatePR(config.repository, number, prUpdateParams);
   },
 

lib/modules/platform/github/index.spec.ts

@@ -3051,6 +3051,44 @@ describe('modules/platform/github/index', () => {
 
       await expect(github.updatePr(pr)).toResolve();
     });
+
+    it('should add and remove labels', async () => {
+      const pr: UpdatePrConfig = {
+        number: 1234,
+        prTitle: 'The New Title',
+        prBody: 'Hello world again',
+        state: 'closed',
+        targetBranch: 'new_base',
+        addLabels: ['new_label'],
+        removeLabels: ['old_label'],
+      };
+      const scope = httpMock.scope(githubApiHost);
+      initRepoMock(scope, 'some/repo');
+      await github.initRepo({ repository: 'some/repo' });
+      scope
+        .patch('/repos/some/repo/pulls/1234')
+        .reply(200, {
+          number: 91,
+          base: { sha: '1234' },
+          head: { ref: 'somebranch', repo: { full_name: 'some/repo' } },
+          state: 'open',
+          title: 'old title',
+          updated_at: '01-09-2022',
+          body: '<!--labels:WyJvbGRfbGFiZWwiXQ==-->', // equivalent to labels array : ['old_label]
+        })
+        .post('/repos/some/repo/issues/1234/labels')
+        .reply(200, pr)
+        .delete('/repos/some/repo/issues/1234/labels/old_label')
+        .reply(200, pr);
+
+      await expect(github.updatePr(pr)).toResolve();
+      expect(logger.logger.debug).toHaveBeenCalledWith(
+        `Adding labels 'new_label' to #1234`
+      );
+      expect(logger.logger.debug).toHaveBeenCalledWith(
+        `Deleting label old_label from #1234`
+      );
+    });
   });
 
   describe('mergePr(prNo)', () => {

lib/modules/platform/github/index.ts

@@ -1673,6 +1673,8 @@ export async function updatePr({
   number: prNo,
   prTitle: title,
   prBody: rawBody,
+  addLabels: labelsToAdd,
+  removeLabels,
   state,
   targetBranch,
 }: UpdatePrConfig): Promise<void> {
@@ -1695,7 +1697,20 @@ export async function updatePr({
   if (config.forkToken) {
     options.token = config.forkToken;
   }
+
   try {
+    // add and remove labels before updating pr body because if by some mishap
+    // labels aren't changed then pr body will have wrong labelsHash
+    if (labelsToAdd) {
+      await addLabels(prNo, labelsToAdd);
+    }
+
+    if (removeLabels) {
+      for (const label of removeLabels) {
+        await deleteLabel(prNo, label);
+      }
+    }
+
     const { body: ghPr } = await githubApi.patchJson<GhRestPr>(
       `repos/${config.parentRepo ?? config.repository}/pulls/${prNo}`,
       options

lib/modules/platform/gitlab/index.spec.ts

@@ -2539,6 +2539,36 @@ describe('modules/platform/gitlab/index', () => {
         })
       ).toResolve();
     });
+
+    it('adds and removes labels', async () => {
+      await initPlatform('13.3.6-ee');
+      httpMock
+        .scope(gitlabApiHost)
+        .get(
+          '/api/v4/projects/undefined/merge_requests?per_page=100&scope=created_by_me'
+        )
+        .reply(200, [
+          {
+            iid: 1,
+            source_branch: 'branch-a',
+            title: 'branch a pr',
+            state: 'open',
+            description: `<!--labels:WyJvbGRfbGFiZWwiXQ==-->`, // equivallent to labels array : ['old_label']
+          },
+        ])
+        .put('/api/v4/projects/undefined/merge_requests/1')
+        .reply(200);
+      await expect(
+        gitlab.updatePr({
+          number: 1,
+          prTitle: 'title',
+          prBody: 'body',
+          state: 'closed',
+          addLabels: ['new_label'],
+          removeLabels: ['old_label'],
+        })
+      ).toResolve();
+    });
   });
 
   describe('mergePr(pr)', () => {

lib/modules/platform/gitlab/index.ts

@@ -750,6 +750,8 @@ export async function updatePr({
   number: iid,
   prTitle,
   prBody: description,
+  addLabels,
+  removeLabels,
   state,
   platformOptions,
   targetBranch,
@@ -772,6 +774,12 @@ export async function updatePr({
   if (targetBranch) {
     body.target_branch = targetBranch;
   }
+  if (addLabels) {
+    body.add_labels = addLabels;
+  }
+  if (removeLabels) {
+    body.remove_labels = removeLabels;
+  }
 
   await gitlabApi.putJson(
     `projects/${config.repository}/merge_requests/${iid}`,