feat(release notes): be able to fetch release notes from Azure DevOps

docs/usage/configuration-options.md

@@ -798,6 +798,7 @@ Renovate can fetch release notes when they are hosted on one of these platforms:
 
 - GitHub (.com and Enterprise Server)
 - GitLab (.com and CE/EE)
+- Azure DevOps (.com)
 
 <!-- prettier-ignore -->
 !!! note

lib/constants/platforms.ts

@@ -23,4 +23,6 @@ export const GITLAB_API_USING_HOST_TYPES = [
   'gitlab-changelog',
 ];
 
+export const AZURE_API_USING_HOST_TYPES = ['azure', 'azure-changelog'];
+
 export const BITBUCKET_API_USING_HOST_TYPES = ['bitbucket', 'bitbucket-tags'];

lib/types/platform/azure/index.ts

@@ -0,0 +1,24 @@
+export type AzureItem = {
+  objectId: string;
+};
+
+export type AzureTreeNode = {
+  objectId: string;
+  relativePath: string;
+  gitObjectType: 'tree' | 'blob';
+};
+
+export type AzureTree = {
+  objectId: string;
+  treeEntries: AzureTreeNode[];
+};
+
+export interface AzureTag {
+  name: string;
+  value: string;
+}
+
+export interface AzureBodyPaginated<T> {
+  count: number;
+  value: T[];
+}

lib/util/common.spec.ts

@@ -13,6 +13,7 @@ describe('util/common', () => {
       ${'https://github-enterprise.example.com/chalk/chalk'} | ${'github'}
       ${'https://gitlab.com/chalk/chalk'}                    | ${'gitlab'}
       ${'https://gitlab-enterprise.example.com/chalk/chalk'} | ${'gitlab'}
+      ${'https://dev.azure.com/chalk/chalk'}                 | ${'azure'}
     `('("$url") === $hostType', ({ url, hostType }) => {
       expect(detectPlatform(url)).toBe(hostType);
     });
@@ -30,12 +31,19 @@ describe('util/common', () => {
         hostType: 'gitea',
         matchHost: 'gt.example.com',
       });
+      hostRules.add({
+        hostType: 'azure-changelog',
+        matchHost: 'az.example.com',
+      });
       expect(detectPlatform('https://gl.example.com/chalk/chalk')).toBe(
         'gitlab'
       );
       expect(detectPlatform('https://gh.example.com/chalk/chalk')).toBe(
         'github'
       );
+      expect(detectPlatform('https://az.example.com/chalk/chalk')).toBe(
+        'azure'
+      );
       expect(detectPlatform('https://gt.example.com/chalk/chalk')).toBeNull();
     });
   });

lib/util/common.ts

@@ -1,4 +1,5 @@
 import {
+  AZURE_API_USING_HOST_TYPES,
   GITHUB_API_USING_HOST_TYPES,
   GITLAB_API_USING_HOST_TYPES,
 } from '../constants';
@@ -11,14 +12,19 @@ import { parseUrl } from './url';
  * @param url the url to detect `platform` from
  * @returns matched `platform` if found, otherwise `null`
  */
-export function detectPlatform(url: string): 'gitlab' | 'github' | null {
+export function detectPlatform(
+  url: string
+): 'gitlab' | 'github' | 'azure' | null {
   const { hostname } = parseUrl(url) ?? {};
   if (hostname === 'github.com' || hostname?.includes('github')) {
     return 'github';
   }
   if (hostname === 'gitlab.com' || hostname?.includes('gitlab')) {
     return 'gitlab';
   }
+  if (hostname === 'dev.azure.com' || hostname?.includes('azure')) {
+    return 'azure';
+  }
 
   const hostType = hostRules.hostType({ url });
 
@@ -32,6 +38,9 @@ export function detectPlatform(url: string): 'gitlab' | 'github' | null {
   if (GITHUB_API_USING_HOST_TYPES.includes(hostType)) {
     return 'github';
   }
+  if (AZURE_API_USING_HOST_TYPES.includes(hostType)) {
+    return 'azure';
+  }
 
   return null;
 }

lib/util/http/azure.spec.ts

@@ -0,0 +1,31 @@
+import * as httpMock from '../../../test/http-mock';
+import { AzureHttp } from './azure';
+
+const azureApiHost = 'https://dev.azure.com';
+
+describe('util/http/azure', () => {
+  let azureApi: AzureHttp;
+
+  beforeEach(() => {
+    azureApi = new AzureHttp();
+  });
+
+  afterEach(() => {
+    jest.resetAllMocks();
+  });
+
+  it('gets paginated JSON', async () => {
+    httpMock
+      .scope(azureApiHost)
+      .get('/some-org/some-project/some-path?$top=2')
+      .reply(200, { value: ['a', 'b'] }, { 'x-ms-continuationtoken': '1' })
+      .get('/some-org/some-project/some-path?$top=2&continuationToken=1')
+      .reply(200, { value: ['c', 'd'] }, { 'x-ms-continuationtoken': '2' })
+      .get('/some-org/some-project/some-path?$top=2&continuationToken=2')
+      .reply(200, { value: ['e'] });
+    const res = await azureApi.getJsonPaginated(
+      'https://dev.azure.com/some-org/some-project/some-path?$top=2'
+    );
+    expect(res.body.value).toHaveLength(5);
+  });
+});

lib/util/http/azure.ts

@@ -0,0 +1,30 @@
+import type { AzureBodyPaginated } from '../../types/platform/azure';
+import type { HttpOptions, HttpResponse } from './types';
+import { Http } from '.';
+
+export class AzureHttp extends Http<HttpOptions> {
+  http: any;
+  constructor(type = 'azure', options?: HttpOptions) {
+    super(type, options);
+  }
+
+  async getJsonPaginated<T>(
+    url: string,
+    continuationToken = ''
+  ): Promise<HttpResponse<AzureBodyPaginated<T>>> {
+    const option = continuationToken
+      ? `&continuationToken=${continuationToken}`
+      : '';
+    const result = await super.getJson<AzureBodyPaginated<T>>(
+      `${url}${option}`
+    );
+    if (result.headers['x-ms-continuationtoken']) {
+      const nextResult = await this.getJsonPaginated<T>(
+        url,
+        result.headers['x-ms-continuationtoken']
+      );
+      result.body.value.push(...nextResult.body.value);
+    }
+    return result;
+  }
+}

lib/util/http/types.ts

@@ -75,6 +75,7 @@ export interface InternalHttpOptions extends HttpOptions {
 
 export interface HttpHeaders extends IncomingHttpHeaders {
   link?: string | undefined;
+  'x-ms-continuationtoken'?: string | undefined;
 }
 
 export interface HttpResponse<T = string> {

lib/workers/repository/update/pr/changelog/__snapshots__/azure.spec.ts.snap

@@ -0,0 +1,217 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`workers/repository/update/pr/changelog/azure getChangeLogJSON handles empty Azure tags response 1`] = `
+{
+  "hasReleaseNotes": false,
+  "project": {
+    "apiBaseUrl": "https://dev.azure.com/some-org/some-project/_apis/",
+    "baseUrl": "https://dev.azure.com/some-org/some-project/",
+    "depName": "renovate",
+    "repository": "some-repo",
+    "sourceDirectory": undefined,
+    "sourceUrl": "https://dev.azure.com/some-org/some-project/_git/some-repo/",
+    "type": "azure",
+  },
+  "versions": [
+    {
+      "changes": [],
+      "compare": {},
+      "date": undefined,
+      "gitRef": undefined,
+      "releaseNotes": null,
+      "version": "5.6.1",
+    },
+    {
+      "changes": [],
+      "compare": {},
+      "date": "2020-02-13T15:37:00.000Z",
+      "gitRef": undefined,
+      "releaseNotes": null,
+      "version": "5.6.0",
+    },
+    {
+      "changes": [],
+      "compare": {},
+      "date": undefined,
+      "gitRef": "eba303e91c930292198b2fc57040145682162a1b",
+      "releaseNotes": null,
+      "version": "5.5.0",
+    },
+    {
+      "changes": [],
+      "compare": {},
+      "date": "2018-08-24T14:23:00.000Z",
+      "gitRef": undefined,
+      "releaseNotes": null,
+      "version": "5.4.0",
+    },
+  ],
+}
+`;
+
+exports[`workers/repository/update/pr/changelog/azure getChangeLogJSON uses Azure tags 1`] = `
+{
+  "hasReleaseNotes": true,
+  "project": {
+    "apiBaseUrl": "https://dev.azure.com/some-org/some-project/_apis/",
+    "baseUrl": "https://dev.azure.com/some-org/some-project/",
+    "depName": "renovate",
+    "repository": "some-repo",
+    "sourceDirectory": undefined,
+    "sourceUrl": "https://dev.azure.com/some-org/some-project/_git/some-repo/",
+    "type": "azure",
+  },
+  "versions": [
+    {
+      "changes": [],
+      "compare": {
+        "url": "https://dev.azure.com/some-org/some-project/_git/some-repo/branchCompare?baseVersion=GTv5.6.0&targetVersion=GTv5.6.1",
+      },
+      "date": undefined,
+      "gitRef": undefined,
+      "releaseNotes": {
+        "notesSourceUrl": "",
+        "url": "https://dev.azure.com/some-org/some-project/_git/some-repo/branchCompare?baseVersion=GTv5.6.0&targetVersion=GTv5.6.1",
+      },
+      "version": "5.6.1",
+    },
+    {
+      "changes": [],
+      "compare": {
+        "url": "https://dev.azure.com/some-org/some-project/_git/some-repo/branchCompare?baseVersion=GTv5.5.0&targetVersion=GTv5.6.0",
+      },
+      "date": "2020-02-13T15:37:00.000Z",
+      "gitRef": undefined,
+      "releaseNotes": {
+        "notesSourceUrl": "",
+        "url": "https://dev.azure.com/some-org/some-project/_git/some-repo/branchCompare?baseVersion=GTv5.5.0&targetVersion=GTv5.6.0",
+      },
+      "version": "5.6.0",
+    },
+    {
+      "changes": [],
+      "compare": {
+        "url": "https://dev.azure.com/some-org/some-project/_git/some-repo/branchCompare?baseVersion=GTv5.4.0&targetVersion=GTv5.5.0",
+      },
+      "date": undefined,
+      "gitRef": "eba303e91c930292198b2fc57040145682162a1b",
+      "releaseNotes": {
+        "notesSourceUrl": "",
+        "url": "https://dev.azure.com/some-org/some-project/_git/some-repo/branchCompare?baseVersion=GTv5.4.0&targetVersion=GTv5.5.0",
+      },
+      "version": "5.5.0",
+    },
+    {
+      "changes": [],
+      "compare": {
+        "url": "https://dev.azure.com/some-org/some-project/_git/some-repo/branchCompare?baseVersion=GTv5.2.0&targetVersion=GTv5.4.0",
+      },
+      "date": "2018-08-24T14:23:00.000Z",
+      "gitRef": undefined,
+      "releaseNotes": {
+        "notesSourceUrl": "",
+        "url": "https://dev.azure.com/some-org/some-project/_git/some-repo/branchCompare?baseVersion=GTv5.2.0&targetVersion=GTv5.4.0",
+      },
+      "version": "5.4.0",
+    },
+  ],
+}
+`;
+
+exports[`workers/repository/update/pr/changelog/azure getChangeLogJSON uses Azure tags with error 1`] = `
+{
+  "hasReleaseNotes": false,
+  "project": {
+    "apiBaseUrl": "https://dev.azure.com/some-org/some-project/_apis/",
+    "baseUrl": "https://dev.azure.com/some-org/some-project/",
+    "depName": "renovate",
+    "repository": "some-repo",
+    "sourceDirectory": undefined,
+    "sourceUrl": "https://dev.azure.com/some-org/some-project/_git/some-repo/",
+    "type": "azure",
+  },
+  "versions": [
+    {
+      "changes": [],
+      "compare": {},
+      "date": undefined,
+      "gitRef": undefined,
+      "releaseNotes": null,
+      "version": "5.6.1",
+    },
+    {
+      "changes": [],
+      "compare": {},
+      "date": "2020-02-13T15:37:00.000Z",
+      "gitRef": undefined,
+      "releaseNotes": null,
+      "version": "5.6.0",
+    },
+    {
+      "changes": [],
+      "compare": {},
+      "date": undefined,
+      "gitRef": "eba303e91c930292198b2fc57040145682162a1b",
+      "releaseNotes": null,
+      "version": "5.5.0",
+    },
+    {
+      "changes": [],
+      "compare": {},
+      "date": "2018-08-24T14:23:00.000Z",
+      "gitRef": undefined,
+      "releaseNotes": null,
+      "version": "5.4.0",
+    },
+  ],
+}
+`;
+
+exports[`workers/repository/update/pr/changelog/azure getChangeLogJSON works without Azure 1`] = `
+{
+  "hasReleaseNotes": false,
+  "project": {
+    "apiBaseUrl": "https://dev.azure.com/some-org/some-project/_apis/",
+    "baseUrl": "https://dev.azure.com/some-org/some-project/",
+    "depName": "renovate",
+    "repository": "some-repo",
+    "sourceDirectory": undefined,
+    "sourceUrl": "https://dev.azure.com/some-org/some-project/_git/some-repo/",
+    "type": "azure",
+  },
+  "versions": [
+    {
+      "changes": [],
+      "compare": {},
+      "date": undefined,
+      "gitRef": undefined,
+      "releaseNotes": null,
+      "version": "5.6.1",
+    },
+    {
+      "changes": [],
+      "compare": {},
+      "date": "2020-02-13T15:37:00.000Z",
+      "gitRef": undefined,
+      "releaseNotes": null,
+      "version": "5.6.0",
+    },
+    {
+      "changes": [],
+      "compare": {},
+      "date": undefined,
+      "gitRef": "eba303e91c930292198b2fc57040145682162a1b",
+      "releaseNotes": null,
+      "version": "5.5.0",
+    },
+    {
+      "changes": [],
+      "compare": {},
+      "date": "2018-08-24T14:23:00.000Z",
+      "gitRef": undefined,
+      "releaseNotes": null,
+      "version": "5.4.0",
+    },
+  ],
+}
+`;