Add warnings alongside deprecated URL patterns (#3715)

Ref #3714

services/discourse/discourse.service.js

@@ -21,6 +21,8 @@ class DiscourseBase extends BaseJsonService {
   static buildRoute(metric) {
     return {
       base: 'discourse',
+      // Do not base new services on this route pattern.
+      // See https://github.com/badges/shields/issues/3714
       pattern: `:scheme(http|https)/:host/${metric}`,
     }
   }

services/jira/jira-issue.service.js

@@ -23,6 +23,8 @@ module.exports = class JiraIssue extends BaseJsonService {
   static get route() {
     return {
       base: 'jira/issue',
+      // Do not base new services on this route pattern.
+      // See https://github.com/badges/shields/issues/3714
       pattern: ':protocol(http|https)/:hostAndPath(.+)/:issueKey',
     }
   }

services/jira/jira-sprint.service.js

@@ -35,6 +35,8 @@ module.exports = class JiraSprint extends BaseJsonService {
   static get route() {
     return {
       base: 'jira/sprint',
+      // Do not base new services on this route pattern.
+      // See https://github.com/badges/shields/issues/3714
       pattern: ':protocol(http|https)/:hostAndPath(.+)/:sprintId',
     }
   }

services/maven-metadata/maven-metadata.service.js

@@ -27,6 +27,8 @@ module.exports = class MavenMetadata extends BaseXmlService {
   static get route() {
     return {
       base: 'maven-metadata/v',
+      // Do not base new services on this route pattern.
+      // See https://github.com/badges/shields/issues/3714
       pattern: ':protocol(http|https)/:hostAndPath+',
     }
   }

services/nexus/nexus.service.js

@@ -44,6 +44,8 @@ module.exports = class Nexus extends BaseJsonService {
       // API pattern:
       // /nexus/(r|s|<repo-name>)/(http|https)/<nexus.host>[:port][/<entry-path>]/<group>/<artifact>[:k1=v1[:k2=v2[...]]]
       pattern:
+        // Do not base new services on this route pattern.
+        // See https://github.com/badges/shields/issues/3714
         ':repo(r|s|[^/]+)/:scheme(http|https)/:hostAndPath+/:groupId/:artifactId([^/:]+):queryOpt(:.+)?',
     }
   }

services/teamcity/teamcity-build.service.js

@@ -22,6 +22,8 @@ module.exports = class TeamCityBuild extends TeamCityBase {
   static get route() {
     return {
       base: 'teamcity',
+      // Do not base new services on this route pattern.
+      // See https://github.com/badges/shields/issues/3714
       format: '(?:codebetter|(http|https)/(.+)/(s|e))/([^/]+)',
       capture: ['protocol', 'hostAndPath', 'verbosity', 'buildId'],
     }

services/teamcity/teamcity-coverage.service.js

@@ -23,6 +23,8 @@ module.exports = class TeamCityCoverage extends TeamCityBase {
 
   static get route() {
     return {
+      // Do not base new services on this route pattern.
+      // See https://github.com/badges/shields/issues/3714
       base: 'teamcity/coverage',
       format: '(?:(http|https)/(.+)/)?([^/]+)',
       capture: ['protocol', 'hostAndPath', 'buildId'],

services/twitter/twitter.service.js

@@ -12,6 +12,8 @@ class TwitterUrl extends BaseService {
   static get route() {
     return {
       base: 'twitter/url',
+      // Do not base new services on this route pattern.
+      // See https://github.com/badges/shields/issues/3714
       pattern: ':protocol(https|http)/:hostAndPath+',
     }
   }

services/website/website.service.js

@@ -35,6 +35,8 @@ module.exports = class Website extends BaseService {
   static get route() {
     return {
       base: 'website',
+      // Do not base new services on this route pattern.
+      // See https://github.com/badges/shields/issues/3714
       pattern: ':protocol(https|http)/:hostAndPath+',
       queryParamSchema,
     }