diff --git a/core/base-service/base.js b/core/base-service/base.js index f604fee774..adeddee886 100644 --- a/core/base-service/base.js +++ b/core/base-service/base.js @@ -86,7 +86,7 @@ class BaseService { throw new Error(`Category not set for ${this.name}`) } - static isDeprecated = false + static isRetired = false /** * Route to mount this service on @@ -208,7 +208,7 @@ class BaseService { } static getDefinition() { - const { category, name, isDeprecated, openApi } = this + const { category, name, isRetired, openApi } = this const { base, format, pattern } = this.route const queryParams = getQueryParamNames(this.route) @@ -221,7 +221,7 @@ class BaseService { route = undefined } - const result = { category, name, isDeprecated, route, openApi } + const result = { category, name, isRetired, route, openApi } assertValidServiceDefinition(result, `getDefinition() for ${this.name}`) diff --git a/core/base-service/base.spec.js b/core/base-service/base.spec.js index 66b86ad615..4593d7528e 100644 --- a/core/base-service/base.spec.js +++ b/core/base-service/base.spec.js @@ -369,17 +369,17 @@ describe('BaseService', function () { describe('getDefinition', function () { it('returns the expected result', function () { - const { category, name, isDeprecated, route, openApi } = + const { category, name, isRetired, route, openApi } = DummyService.getDefinition() expect({ category, name, - isDeprecated, + isRetired, route, }).to.deep.equal({ category: 'other', name: 'DummyService', - isDeprecated: false, + isRetired: false, route: { pattern: '/foo/:namedParamA', queryParams: ['queryParamA', 'legacyQueryParamA'], diff --git a/core/base-service/index.js b/core/base-service/index.js index 5fc3eac35f..d8127ebacb 100644 --- a/core/base-service/index.js +++ b/core/base-service/index.js @@ -6,7 +6,7 @@ import BaseSvgScrapingService from './base-svg-scraping.js' import BaseTomlService from './base-toml.js' import BaseXmlService from './base-xml.js' import BaseYamlService from './base-yaml.js' -import deprecatedService from './deprecated-service.js' +import retiredService from './retired-service.js' import redirector from './redirector.js' import { NotFound, @@ -26,7 +26,7 @@ export { BaseTomlService, BaseXmlService, BaseYamlService, - deprecatedService, + retiredService, redirector, NotFound, InvalidResponse, diff --git a/core/base-service/redirector.js b/core/base-service/redirector.js index b837352386..8bcc4f12d7 100644 --- a/core/base-service/redirector.js +++ b/core/base-service/redirector.js @@ -16,7 +16,7 @@ import trace from './trace.js' const attrSchema = Joi.object({ name: Joi.string().min(3), category: isValidCategory, - isDeprecated: Joi.boolean().default(true), + isRetired: Joi.boolean().default(true), route: isValidRoute, openApi: openApiSchema, transformPath: Joi.func() @@ -35,7 +35,7 @@ export default function redirector(attrs) { const { name, category, - isDeprecated, + isRetired, route, openApi, transformPath, @@ -51,7 +51,7 @@ export default function redirector(attrs) { })}Redirect` static category = category - static isDeprecated = isDeprecated + static isRetired = isRetired static route = route static openApi = openApi diff --git a/core/base-service/redirector.spec.js b/core/base-service/redirector.spec.js index 68bdb65d28..0273d85ee3 100644 --- a/core/base-service/redirector.spec.js +++ b/core/base-service/redirector.spec.js @@ -14,8 +14,8 @@ describe('Redirector', function () { const dateAdded = new Date() const attrs = { category, route, transformPath, dateAdded } - it('returns true on isDeprecated', function () { - expect(redirector(attrs).isDeprecated).to.be.true + it('returns true on isRetired', function () { + expect(redirector(attrs).isRetired).to.be.true }) it('has the expected name', function () { diff --git a/core/base-service/deprecated-service.js b/core/base-service/retired-service.js similarity index 78% rename from core/base-service/deprecated-service.js rename to core/base-service/retired-service.js index fe3e4aa806..667afe1ef4 100644 --- a/core/base-service/deprecated-service.js +++ b/core/base-service/retired-service.js @@ -13,22 +13,22 @@ const attrSchema = Joi.object({ issueUrl: Joi.string().uri(), }).required() -function deprecatedService(attrs) { +function retiredService(attrs) { const { route, name, label, category, issueUrl } = Joi.attempt( attrs, attrSchema, - `Deprecated service for ${attrs.route.base}`, + `Retired service for ${attrs.route.base}`, ) - return class DeprecatedService extends BaseService { + return class RetiredService extends BaseService { static name = name - ? `Deprecated${name}` - : `Deprecated${camelcase(route.base.replace(/\//g, '_'), { + ? `Retired${name}` + : `Retired${camelcase(route.base.replace(/\//g, '_'), { pascalCase: true, })}` static category = category - static isDeprecated = true + static isRetired = true static route = route static _cacheLength = 86400 static defaultBadgeData = { @@ -51,4 +51,4 @@ function deprecatedService(attrs) { } } -export default deprecatedService +export default retiredService diff --git a/core/base-service/deprecated-service.spec.js b/core/base-service/retired-service.spec.js similarity index 64% rename from core/base-service/deprecated-service.spec.js rename to core/base-service/retired-service.spec.js index c0779da07d..c48d26c20b 100644 --- a/core/base-service/deprecated-service.spec.js +++ b/core/base-service/retired-service.spec.js @@ -1,7 +1,7 @@ import { expect } from 'chai' -import deprecatedService from './deprecated-service.js' +import retiredService from './retired-service.js' -describe('DeprecatedService', function () { +describe('RetiredService', function () { const route = { base: 'service/that/no/longer/exists', pattern: ':various+', @@ -10,46 +10,46 @@ describe('DeprecatedService', function () { const dateAdded = new Date() const commonAttrs = { route, category, dateAdded } - it('returns true on isDeprecated', function () { - const service = deprecatedService({ ...commonAttrs }) - expect(service.isDeprecated).to.be.true + it('returns true on isRetired', function () { + const service = retiredService({ ...commonAttrs }) + expect(service.isRetired).to.be.true }) it('has the expected name', function () { - const service = deprecatedService({ ...commonAttrs }) - expect(service.name).to.equal('DeprecatedServiceThatNoLongerExists') + const service = retiredService({ ...commonAttrs }) + expect(service.name).to.equal('RetiredServiceThatNoLongerExists') }) it('sets specified route', function () { - const service = deprecatedService({ ...commonAttrs }) + const service = retiredService({ ...commonAttrs }) expect(service.route).to.deep.equal(route) }) it('sets specified label', function () { const label = 'coverity' - const service = deprecatedService({ ...commonAttrs, label }) + const service = retiredService({ ...commonAttrs, label }) expect(service.defaultBadgeData.label).to.equal(label) }) it('sets specified category', function () { - const service = deprecatedService({ ...commonAttrs }) + const service = retiredService({ ...commonAttrs }) expect(service.category).to.equal(category) }) it('sets default deprecation message', async function () { - const service = deprecatedService({ ...commonAttrs }) + const service = retiredService({ ...commonAttrs }) expect(await service.invoke()).to.deep.equal({ message: 'retired badge', }) }) it('sets default deprecation color', async function () { - const service = deprecatedService({ ...commonAttrs }) + const service = retiredService({ ...commonAttrs }) expect(service.defaultBadgeData.color).to.equal('lightgray') }) it('sets specified issue URL and sets red color', async function () { - const service = deprecatedService({ + const service = retiredService({ ...commonAttrs, issueUrl: 'https://github.com/badges/shields/issues/8671', }) diff --git a/core/base-service/service-definitions.js b/core/base-service/service-definitions.js index cb66e1d12b..c5730ec2a6 100644 --- a/core/base-service/service-definitions.js +++ b/core/base-service/service-definitions.js @@ -43,7 +43,7 @@ const openApiSchema = Joi.object() const serviceDefinition = Joi.object({ category: Joi.string().required(), name: Joi.string().required(), - isDeprecated: Joi.boolean().required(), + isRetired: Joi.boolean().required(), route: Joi.alternatives().try( Joi.object({ pattern: Joi.string().required(), diff --git a/doc/badge-redirectors.md b/doc/badge-redirectors.md index 54e0bbd437..2dfe93a863 100644 --- a/doc/badge-redirectors.md +++ b/doc/badge-redirectors.md @@ -24,8 +24,8 @@ Every redirector must specify: - **`name`** - Custom name for the service class (auto-generated from route if not specified) - **`transformQueryParams`** - A function to transform path parameters into query parameters - **`overrideTransformedQueryParams`** - Boolean (default: `false`). When `true`, query params from the URL take precedence over transformed params in case of conflicts -- **`isDeprecated`** - Boolean (default: `true`). Set to `false` for non-deprecated redirectors that should appear in the API documentation -- **`openApi`** - OpenAPI documentation object. Only needed for non-deprecated redirectors (`isDeprecated: false`) that should appear in the user-facing documentation +- **`isRetired`** - Boolean (default: `true`). Set to `false` for non-retired redirectors that should appear in the API documentation +- **`openApi`** - OpenAPI documentation object. Only needed for non-retired redirectors (`isRetired: false`) that should appear in the user-facing documentation ## Examples @@ -117,7 +117,7 @@ If a user specifies `/old/service/token/abc123/foo?token=xyz789`, `xyz789` takes ### Example 5: Non-Deprecated Redirector with Documentation -In some cases, a badged based on a redirector may not be deprecated and should appear on the website. This requires setting `isDeprecated: false` and providing an `openApi` specification: +In some cases, a badged based on a redirector may not be retired and should appear on the website. This requires setting `isRetired: false` and providing an `openApi` specification: ```js import { redirector, pathParam } from '../index.js' @@ -125,7 +125,7 @@ import { commonParams } from '../maven-metadata/maven-metadata.js' export default redirector({ category: 'version', - isDeprecated: false, + isRetired: false, route: { base: 'gradle-plugin-portal/v', pattern: ':pluginId', @@ -213,12 +213,12 @@ We'll keep the redirector for a minimum of one year. It may stay in place for si - The redirector led to less than 100 badge renders on a weekday. - The redirector serves less than 1% of the traffic of the new badge URL it points to. -It can then be removed and replaced with a deprecated badge linking to an issue that explains the migration path, for example: +It can then be removed and replaced with a retired badge linking to an issue that explains the migration path, for example: ```js -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' -export default deprecatedService({ +export default retiredService({ category: 'build', route: { base: 'github/workflow/status', @@ -232,4 +232,4 @@ export default deprecatedService({ Doing so will render badges similar to the following: ![](https://img.shields.io/badge/githubworkflowstatus-https%3A%2F%2Fgithub.com%2Fbadges%2Fshields%2Fissues%2F8671-red) -Removal of the resulting deprecated badge follows the process documented [here](./deprecating-badges.md). +Removal of the resulting retired badge follows the process documented [here](./retiring-badges.md). diff --git a/doc/deprecating-badges.md b/doc/retiring-badges.md similarity index 72% rename from doc/deprecating-badges.md rename to doc/retiring-badges.md index bb507b7030..55d64475ab 100644 --- a/doc/deprecating-badges.md +++ b/doc/retiring-badges.md @@ -1,26 +1,26 @@ # Deprecating Badges -When a service that Shields integrates with shuts down, those badges will no longer work and need to be deprecated within Shields. +When a service that Shields integrates with shuts down, those badges will no longer work and need to be retired (deprecated) within Shields. Deprecating a badge involves two steps: -1. Updating the service code to use the `DeprecatedService` class -2. Updating the service tests to reflect the new behavior of the deprecated service +1. Updating the service code to use the `RetiredService` class +2. Updating the service tests to reflect the new behavior of the retired service ## Update Service Implementation Locate the source file(s) for the service, which can be found in `*.service.js` files located within the directory for the service (`./services/:service-name/`) such as `./services/imagelayers/imagelayers.service.js`. -Replace the existing service class implementation with the `DeprecatedService` class from `./core/base-service/deprecated-service.js` using the respective `category`, `route`, and `label` values for that service. +Replace the existing service class implementation with the `RetiredService` class from `./core/base-service/retired-service.js` using the respective `category`, `route`, and `label` values for that service. Set the badge label to the service name. This ensures users can immediately identify which service is no longer available at a glance. For example: ```js -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' -export default deprecatedService({ +export default retiredService({ category: 'size', route: { base: 'imagelayers', @@ -35,7 +35,7 @@ export default deprecatedService({ Locate the test file(s) for the service, which can be found in `*.tester.js` files located in the service directory (`./services/:service-name/`), such as `./services/imagelayers/imagelayers.tester.js`. -With `DeprecatedService` classes we cannot use `createServiceTester()` so you will need to create the `ServiceTester` class directly. For example: +With `RetiredService` classes we cannot use `createServiceTester()` so you will need to create the `ServiceTester` class directly. For example: ```js import { ServiceTester } from '../tester.js' @@ -46,7 +46,7 @@ export const t = new ServiceTester({ }) ``` -Next you will need to replace/refactor the existing tests to validate the new deprecated badge behavior for this service. Deprecated badges always return a message of `retired badge` (such as `imagelayers | retired badge`) so the tests need to be updated to reflect that message value. For example: +Next you will need to replace/refactor the existing tests to validate the new retired badge behavior for this service. Retired badges always return a message of `retired badge` (such as `imagelayers | retired badge`) so the tests need to be updated to reflect that message value. For example: ```js t.create('retired badge (previously image size)') @@ -86,7 +86,7 @@ t.create('retired badge (previously number of layers)') ## What Happens Next? -Once a service is deprecated, we'll keep the deprecation notice for a minimum of one year. During that time, the badge will render as follows: ![](https://img.shields.io/badge/gratipay-no%20longer%20available-inactive) +Once a service is retired, we'll keep the deprecation notice for a minimum of one year. During that time, the badge will render as follows: ![](https://img.shields.io/badge/gratipay-no%20longer%20available-inactive) Past that point, all related code will be deleted, and a not found error will be rendered instead: ![](https://img.shields.io/badge/404-badge%20not%20found-critical) @@ -143,4 +143,4 @@ Some other information that may be useful: - [Contributing Docs](../CONTRIBUTING.md) - [Badge Tutorial](./TUTORIAL.md) - [Service Tests Tutorial](./service-tests.md) -- Previous Pull Requests that deprecated badges like [#10371](https://github.com/badges/shields/pull/10371) and [#11075](https://github.com/badges/shields/pull/11075) +- Previous Pull Requests that retired badges like [#10371](https://github.com/badges/shields/pull/10371) and [#11075](https://github.com/badges/shields/pull/11075) diff --git a/eslint.config.js b/eslint.config.js index 07729f525d..56c9819342 100644 --- a/eslint.config.js +++ b/eslint.config.js @@ -115,7 +115,7 @@ const servicesConfig = { order: [ 'name', 'category', - 'isDeprecated', + 'isRetired', 'route', 'auth', 'openApi', diff --git a/scripts/export-openapi-cli.js b/scripts/export-openapi-cli.js index 0a1beb8bfa..b5fbf410b7 100644 --- a/scripts/export-openapi-cli.js +++ b/scripts/export-openapi-cli.js @@ -22,7 +22,7 @@ function writeSpec(filename, spec) { for (const category of definitions.categories) { const services = definitions.services.filter( - service => service.category === category.id && !service.isDeprecated, + service => service.category === category.id && !service.isRetired, ) writeSpec( @@ -34,12 +34,12 @@ function writeSpec(filename, spec) { let coreServices = [] coreServices = coreServices.concat( definitions.services.filter( - service => service.category === 'static' && !service.isDeprecated, + service => service.category === 'static' && !service.isRetired, ), ) coreServices = coreServices.concat( definitions.services.filter( - service => service.category === 'dynamic' && !service.isDeprecated, + service => service.category === 'dynamic' && !service.isRetired, ), ) writeSpec( diff --git a/services/amo/amo-downloads.service.js b/services/amo/amo-downloads.service.js index 40e96be867..3d041653f8 100644 --- a/services/amo/amo-downloads.service.js +++ b/services/amo/amo-downloads.service.js @@ -1,5 +1,5 @@ import { renderDownloadsBadge } from '../downloads.js' -import { deprecatedService, pathParams } from '../index.js' +import { retiredService, pathParams } from '../index.js' import { BaseAmoService, description as baseDescription } from './amo-base.js' const description = `${baseDescription} @@ -39,7 +39,7 @@ class AmoWeeklyDownloads extends BaseAmoService { } } -const AmoLegacyRedirect = deprecatedService({ +const AmoLegacyRedirect = retiredService({ category: 'downloads', label: 'mozilla-add-on', route: { diff --git a/services/azure-devops/vso-redirect.service.js b/services/azure-devops/vso-redirect.service.js index 47231f8fa5..642a5c53fa 100644 --- a/services/azure-devops/vso-redirect.service.js +++ b/services/azure-devops/vso-redirect.service.js @@ -1,6 +1,6 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' -export const VsoBuildRedirector = deprecatedService({ +export const VsoBuildRedirector = retiredService({ category: 'build', label: 'vso', route: { @@ -10,7 +10,7 @@ export const VsoBuildRedirector = deprecatedService({ dateAdded: new Date('2025-12-20'), issueUrl: 'https://github.com/badges/shields/pull/11583', }) -export const VsoReleaseRedirector = deprecatedService({ +export const VsoReleaseRedirector = retiredService({ category: 'build', label: 'vso', route: { diff --git a/services/bit/bit-components.service.js b/services/bit/bit-components.service.js index bafa7029af..60a6e70066 100644 --- a/services/bit/bit-components.service.js +++ b/services/bit/bit-components.service.js @@ -1,6 +1,6 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' -export const BitComponents = deprecatedService({ +export const BitComponents = retiredService({ category: 'other', route: { base: 'bit/collection/total-components', diff --git a/services/circleci/circleci.service.js b/services/circleci/circleci.service.js index 7d305b3693..38d9f43f9c 100644 --- a/services/circleci/circleci.service.js +++ b/services/circleci/circleci.service.js @@ -2,7 +2,7 @@ import Joi from 'joi' import { isBuildStatus, renderBuildStatusBadge } from '../build-status.js' import { BaseSvgScrapingService, - deprecatedService, + retiredService, redirector, pathParam, queryParam, @@ -108,7 +108,7 @@ class CircleCi extends BaseSvgScrapingService { } const legacyRoutes = [ - deprecatedService({ + retiredService({ category: 'build', label: 'circleci', route: { diff --git a/services/clojars/clojars-version.service.js b/services/clojars/clojars-version.service.js index 018f473266..beb3ed8c15 100644 --- a/services/clojars/clojars-version.service.js +++ b/services/clojars/clojars-version.service.js @@ -1,6 +1,6 @@ import Joi from 'joi' import { version as versionColor } from '../color-formatters.js' -import { deprecatedService, pathParam, queryParam } from '../index.js' +import { retiredService, pathParam, queryParam } from '../index.js' import { BaseClojarsService, description } from './clojars-base.js' const queryParamSchema = Joi.object({ @@ -58,7 +58,7 @@ class ClojarsVersionService extends BaseClojarsService { } } -const ClojarsVersionRedirector = deprecatedService({ +const ClojarsVersionRedirector = retiredService({ category: 'version', label: 'clojars', route: { diff --git a/services/codeclimate/codeclimate.service.js b/services/codeclimate/codeclimate.service.js index d4cb6a885a..7d1730c98a 100644 --- a/services/codeclimate/codeclimate.service.js +++ b/services/codeclimate/codeclimate.service.js @@ -1,6 +1,6 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' -export const CodeClimate = deprecatedService({ +export const CodeClimate = retiredService({ category: 'analysis', route: { base: 'codeclimate', diff --git a/services/codecov/codecov-redirect.service.js b/services/codecov/codecov-redirect.service.js index 484f03d61e..ec79d1b0e5 100644 --- a/services/codecov/codecov-redirect.service.js +++ b/services/codecov/codecov-redirect.service.js @@ -1,7 +1,7 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' export default [ - deprecatedService({ + retiredService({ category: 'coverage', label: 'codecov', route: { diff --git a/services/codeship/codeship.service.js b/services/codeship/codeship.service.js index 0685d7dd26..ef20589f6a 100644 --- a/services/codeship/codeship.service.js +++ b/services/codeship/codeship.service.js @@ -1,6 +1,6 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' -export default deprecatedService({ +export default retiredService({ category: 'build', route: { base: 'codeship', diff --git a/services/coincap/coincap.service.js b/services/coincap/coincap.service.js index b08250b813..6351106765 100644 --- a/services/coincap/coincap.service.js +++ b/services/coincap/coincap.service.js @@ -1,6 +1,6 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' -export const Coincap = deprecatedService({ +export const Coincap = retiredService({ category: 'other', route: { base: 'coincap', diff --git a/services/docker/docker-cloud-automated.service.js b/services/docker/docker-cloud-automated.service.js index adc25bf3da..f31a997087 100644 --- a/services/docker/docker-cloud-automated.service.js +++ b/services/docker/docker-cloud-automated.service.js @@ -1,6 +1,6 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' -export default deprecatedService({ +export default retiredService({ category: 'build', route: { base: 'docker/cloud/automated', diff --git a/services/docker/docker-cloud-build.service.js b/services/docker/docker-cloud-build.service.js index de0caccc35..74aa04152f 100644 --- a/services/docker/docker-cloud-build.service.js +++ b/services/docker/docker-cloud-build.service.js @@ -1,6 +1,6 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' -export default deprecatedService({ +export default retiredService({ category: 'build', route: { base: 'docker/cloud/build', diff --git a/services/endpoint/endpoint-redirect.service.js b/services/endpoint/endpoint-redirect.service.js index 9ab34660cc..9354fecaaa 100644 --- a/services/endpoint/endpoint-redirect.service.js +++ b/services/endpoint/endpoint-redirect.service.js @@ -1,6 +1,6 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' -export default deprecatedService({ +export default retiredService({ category: 'other', label: 'endpoint', route: { diff --git a/services/github/gist/github-gist-stars-redirect.service.js b/services/github/gist/github-gist-stars-redirect.service.js index 49a2d51d5f..8d2b4b8c13 100644 --- a/services/github/gist/github-gist-stars-redirect.service.js +++ b/services/github/gist/github-gist-stars-redirect.service.js @@ -1,6 +1,6 @@ -import { deprecatedService } from '../../index.js' +import { retiredService } from '../../index.js' -export default deprecatedService({ +export default retiredService({ category: 'social', label: 'github', route: { base: 'github/stars/gists', pattern: ':gistId' }, diff --git a/services/github/github-issue-detail-redirect.service.js b/services/github/github-issue-detail-redirect.service.js index 530087242e..4e56b30620 100644 --- a/services/github/github-issue-detail-redirect.service.js +++ b/services/github/github-issue-detail-redirect.service.js @@ -1,7 +1,7 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' export default [ - deprecatedService({ + retiredService({ category: 'issue-tracking', label: 'github', route: { diff --git a/services/github/github-workflow-status.service.js b/services/github/github-workflow-status.service.js index 26b34727db..41004e1c67 100644 --- a/services/github/github-workflow-status.service.js +++ b/services/github/github-workflow-status.service.js @@ -1,6 +1,6 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' -export default deprecatedService({ +export default retiredService({ category: 'build', route: { base: 'github/workflow/status', diff --git a/services/gitlab/gitlab-contributors-redirect.service.js b/services/gitlab/gitlab-contributors-redirect.service.js index ca1f2587bf..b53240a26b 100644 --- a/services/gitlab/gitlab-contributors-redirect.service.js +++ b/services/gitlab/gitlab-contributors-redirect.service.js @@ -1,7 +1,7 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' // https://github.com/badges/shields/issues/8138 -export default deprecatedService({ +export default retiredService({ category: 'build', label: 'gitlab', route: { diff --git a/services/gitlab/gitlab-coverage-redirect.service.js b/services/gitlab/gitlab-coverage-redirect.service.js index baed5d89d9..15633e37db 100644 --- a/services/gitlab/gitlab-coverage-redirect.service.js +++ b/services/gitlab/gitlab-coverage-redirect.service.js @@ -1,6 +1,6 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' -export default deprecatedService({ +export default retiredService({ category: 'coverage', label: 'gitlab', route: { diff --git a/services/gitlab/gitlab-license-redirect.service.js b/services/gitlab/gitlab-license-redirect.service.js index 27b0ff0306..9513d6ae2b 100644 --- a/services/gitlab/gitlab-license-redirect.service.js +++ b/services/gitlab/gitlab-license-redirect.service.js @@ -1,7 +1,7 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' // https://github.com/badges/shields/issues/8138 -export default deprecatedService({ +export default retiredService({ category: 'build', label: 'gitlab', route: { diff --git a/services/gradle-plugin-portal/gradle-plugin-portal.service.js b/services/gradle-plugin-portal/gradle-plugin-portal.service.js index 4992c7e40f..02b5116131 100644 --- a/services/gradle-plugin-portal/gradle-plugin-portal.service.js +++ b/services/gradle-plugin-portal/gradle-plugin-portal.service.js @@ -3,7 +3,7 @@ import { commonParams } from '../maven-metadata/maven-metadata.js' export default redirector({ category: 'version', - isDeprecated: false, + isRetired: false, route: { base: 'gradle-plugin-portal/v', pattern: ':pluginId', diff --git a/services/hackage/hackage-deps.service.js b/services/hackage/hackage-deps.service.js index 07e3b01360..3060a1bbf9 100644 --- a/services/hackage/hackage-deps.service.js +++ b/services/hackage/hackage-deps.service.js @@ -1,6 +1,6 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' -export const HackageDeps = deprecatedService({ +export const HackageDeps = retiredService({ category: 'dependencies', route: { base: 'hackage-deps/v', diff --git a/services/jenkins/jenkins-build-redirect.service.js b/services/jenkins/jenkins-build-redirect.service.js index ffc66d345f..6c9a9939e5 100644 --- a/services/jenkins/jenkins-build-redirect.service.js +++ b/services/jenkins/jenkins-build-redirect.service.js @@ -1,4 +1,4 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' const commonProps = { category: 'build', @@ -8,21 +8,21 @@ const commonProps = { } export default [ - deprecatedService({ + retiredService({ route: { base: 'jenkins-ci/s', pattern: ':protocol(http|https)/:host/:job+', }, ...commonProps, }), - deprecatedService({ + retiredService({ route: { base: 'jenkins/s', pattern: ':protocol(http|https)/:host/:job+', }, ...commonProps, }), - deprecatedService({ + retiredService({ route: { base: 'jenkins/build', pattern: ':protocol(http|https)/:host/:job+', diff --git a/services/jenkins/jenkins-coverage-redirector.service.js b/services/jenkins/jenkins-coverage-redirector.service.js index 081fd35935..6d343e6c74 100644 --- a/services/jenkins/jenkins-coverage-redirector.service.js +++ b/services/jenkins/jenkins-coverage-redirector.service.js @@ -1,4 +1,4 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' const commonProps = { category: 'coverage', @@ -8,14 +8,14 @@ const commonProps = { } export default [ - deprecatedService({ + retiredService({ route: { base: 'jenkins', pattern: ':coverageFormat(j|c)/:protocol(http|https)/:host/:job+', }, ...commonProps, }), - deprecatedService({ + retiredService({ route: { base: 'jenkins/coverage', pattern: @@ -23,7 +23,7 @@ export default [ }, ...commonProps, }), - deprecatedService({ + retiredService({ route: { base: 'jenkins/coverage/api', pattern: '', diff --git a/services/jenkins/jenkins-tests-redirector.service.js b/services/jenkins/jenkins-tests-redirector.service.js index 3cb30a4cc4..ebda3f48f1 100644 --- a/services/jenkins/jenkins-tests-redirector.service.js +++ b/services/jenkins/jenkins-tests-redirector.service.js @@ -1,4 +1,4 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' const commonProps = { category: 'build', @@ -8,14 +8,14 @@ const commonProps = { } export default [ - deprecatedService({ + retiredService({ route: { base: 'jenkins/t', pattern: ':protocol(http|https)/:host/:job+', }, ...commonProps, }), - deprecatedService({ + retiredService({ route: { base: 'jenkins/tests', pattern: ':protocol(http|https)/:host/:job+', diff --git a/services/jira/jira-issue-redirect.service.js b/services/jira/jira-issue-redirect.service.js index ac53bac4ef..89a75596a7 100644 --- a/services/jira/jira-issue-redirect.service.js +++ b/services/jira/jira-issue-redirect.service.js @@ -1,7 +1,7 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' export default [ - deprecatedService({ + retiredService({ category: 'issue-tracking', label: 'jira', route: { diff --git a/services/jira/jira-sprint-redirect.service.js b/services/jira/jira-sprint-redirect.service.js index 7faa434c90..840b9f4896 100644 --- a/services/jira/jira-sprint-redirect.service.js +++ b/services/jira/jira-sprint-redirect.service.js @@ -1,7 +1,7 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' export default [ - deprecatedService({ + retiredService({ category: 'issue-tracking', label: 'jira', route: { diff --git a/services/jitpack/jitpack-version-redirector.service.js b/services/jitpack/jitpack-version-redirector.service.js index bbc62145d9..e2c23fafe5 100644 --- a/services/jitpack/jitpack-version-redirector.service.js +++ b/services/jitpack/jitpack-version-redirector.service.js @@ -1,7 +1,7 @@ -import { deprecatedService, redirector } from '../index.js' +import { retiredService, redirector } from '../index.js' export default [ - deprecatedService({ + retiredService({ category: 'version', label: 'jitpack', name: 'JitpackVersionGitHubRedirect', diff --git a/services/maven-central/maven-central.service.js b/services/maven-central/maven-central.service.js index 8c19f741f7..402d261c5e 100644 --- a/services/maven-central/maven-central.service.js +++ b/services/maven-central/maven-central.service.js @@ -3,7 +3,7 @@ import { commonParams } from '../maven-metadata/maven-metadata.js' export default redirector({ category: 'version', - isDeprecated: false, + isRetired: false, route: { base: 'maven-central/v', pattern: ':groupId/:artifactId/:versionPrefix?', diff --git a/services/nostr-band/nostr-band-followers.service.js b/services/nostr-band/nostr-band-followers.service.js index 96bd23a0d5..1758a03d30 100644 --- a/services/nostr-band/nostr-band-followers.service.js +++ b/services/nostr-band/nostr-band-followers.service.js @@ -1,6 +1,6 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' -export default deprecatedService({ +export default retiredService({ category: 'social', route: { base: 'nostrband/followers', diff --git a/services/nuget/nuget-v2-service-family.js b/services/nuget/nuget-v2-service-family.js index 22c84c393b..0b384226da 100644 --- a/services/nuget/nuget-v2-service-family.js +++ b/services/nuget/nuget-v2-service-family.js @@ -4,7 +4,7 @@ import { nonNegativeInteger } from '../validators.js' import { BaseXmlService, NotFound, - deprecatedService, + retiredService, pathParams, pathParam, queryParam, @@ -135,7 +135,7 @@ function createServiceFamily({ } } - const NugetVersionRedirector = deprecatedService({ + const NugetVersionRedirector = retiredService({ category: 'version', label: defaultLabel, route: { diff --git a/services/offset-earth/offset-earth-carbon-redirect.service.js b/services/offset-earth/offset-earth-carbon-redirect.service.js index b4b3feaab7..8d107b7219 100644 --- a/services/offset-earth/offset-earth-carbon-redirect.service.js +++ b/services/offset-earth/offset-earth-carbon-redirect.service.js @@ -1,8 +1,8 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' export default [ // https://github.com/badges/shields/issues/5433 - deprecatedService({ + retiredService({ name: 'OffsetEarthCarbonRedirect', category: 'other', label: 'offset-earth', diff --git a/services/offset-earth/offset-earth-trees-redirect.service.js b/services/offset-earth/offset-earth-trees-redirect.service.js index 8e3c7f411c..fa26187a57 100644 --- a/services/offset-earth/offset-earth-trees-redirect.service.js +++ b/services/offset-earth/offset-earth-trees-redirect.service.js @@ -1,8 +1,8 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' export default [ // https://github.com/badges/shields/issues/5433 - deprecatedService({ + retiredService({ name: 'OffsetEarthTreesRedirect', category: 'other', label: 'offset-earth', diff --git a/services/pub/pub-popularity.service.js b/services/pub/pub-popularity.service.js index 787c6889f5..76d7a255e3 100644 --- a/services/pub/pub-popularity.service.js +++ b/services/pub/pub-popularity.service.js @@ -1,6 +1,6 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' -export const PubPopularity = deprecatedService({ +export const PubPopularity = retiredService({ category: 'rating', route: { base: 'pub/popularity', diff --git a/services/pub/pub.service.js b/services/pub/pub.service.js index bd52027232..696a6afb23 100644 --- a/services/pub/pub.service.js +++ b/services/pub/pub.service.js @@ -2,7 +2,7 @@ import Joi from 'joi' import { latest, renderVersionBadge } from '../version.js' import { BaseJsonService, - deprecatedService, + retiredService, pathParam, queryParam, } from '../index.js' @@ -65,7 +65,7 @@ class PubVersion extends BaseJsonService { } } -const PubVersionRedirector = deprecatedService({ +const PubVersionRedirector = retiredService({ category: 'version', label: 'pub', route: { diff --git a/services/security-headers/security-headers.service.js b/services/security-headers/security-headers.service.js index 72725335d7..91109400c1 100644 --- a/services/security-headers/security-headers.service.js +++ b/services/security-headers/security-headers.service.js @@ -1,6 +1,6 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' -export const SecurityHeaders = deprecatedService({ +export const SecurityHeaders = retiredService({ category: 'monitoring', route: { base: 'security-headers', diff --git a/services/swagger/swagger-redirect.service.js b/services/swagger/swagger-redirect.service.js index 5ddeb4d224..489f39a4c0 100644 --- a/services/swagger/swagger-redirect.service.js +++ b/services/swagger/swagger-redirect.service.js @@ -1,7 +1,7 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' export default [ - deprecatedService({ + retiredService({ category: 'other', label: 'swagger', name: 'SwaggerRedirect', diff --git a/services/teamcity/teamcity-build-redirect.service.js b/services/teamcity/teamcity-build-redirect.service.js index ea7998f59b..a9ac6b0269 100644 --- a/services/teamcity/teamcity-build-redirect.service.js +++ b/services/teamcity/teamcity-build-redirect.service.js @@ -1,7 +1,7 @@ -import { deprecatedService, redirector } from '../index.js' +import { retiredService, redirector } from '../index.js' export default [ - deprecatedService({ + retiredService({ name: 'TeamCityBuildLegacyCodeBetterRedirect', category: 'build', label: 'teamcity', diff --git a/services/twitter/twitter.service.js b/services/twitter/twitter.service.js index f613e2e39c..dce025e06b 100644 --- a/services/twitter/twitter.service.js +++ b/services/twitter/twitter.service.js @@ -54,7 +54,7 @@ This badge is unusual. We don't usually host badges that don't show any dynamic information. Also when an upstream API is removed, we usually deprecate/remove badges according to the process in -https://github.com/badges/shields/blob/master/doc/deprecating-badges.md +https://github.com/badges/shields/blob/master/doc/retiring-badges.md In the case of twitter, we decided to provide a static fallback instead due to how widely used the badge was. See diff --git a/services/visual-studio-app-center/visual-studio-app-center-builds.service.js b/services/visual-studio-app-center/visual-studio-app-center-builds.service.js index 447901b071..5f4ca0935a 100644 --- a/services/visual-studio-app-center/visual-studio-app-center-builds.service.js +++ b/services/visual-studio-app-center/visual-studio-app-center-builds.service.js @@ -1,7 +1,7 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' // Visual Studio App Center was retired. See: https://learn.microsoft.com/en-us/appcenter/retirement -const VisualStudioAppCenterBuilds = deprecatedService({ +const VisualStudioAppCenterBuilds = retiredService({ category: 'build', route: { base: 'visual-studio-app-center/builds', diff --git a/services/visual-studio-app-center/visual-studio-app-center-releases-osversion.service.js b/services/visual-studio-app-center/visual-studio-app-center-releases-osversion.service.js index c04500b441..78cc73a2dc 100644 --- a/services/visual-studio-app-center/visual-studio-app-center-releases-osversion.service.js +++ b/services/visual-studio-app-center/visual-studio-app-center-releases-osversion.service.js @@ -1,7 +1,7 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' // Visual Studio App Center was retired. See: https://learn.microsoft.com/en-us/appcenter/retirement -const VisualStudioAppCenterReleasesOSVersion = deprecatedService({ +const VisualStudioAppCenterReleasesOSVersion = retiredService({ category: 'version', route: { base: 'visual-studio-app-center/releases/osver', diff --git a/services/visual-studio-app-center/visual-studio-app-center-releases-size.service.js b/services/visual-studio-app-center/visual-studio-app-center-releases-size.service.js index 57e9de1574..831c14fc30 100644 --- a/services/visual-studio-app-center/visual-studio-app-center-releases-size.service.js +++ b/services/visual-studio-app-center/visual-studio-app-center-releases-size.service.js @@ -1,7 +1,7 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' // Visual Studio App Center was retired. See: https://learn.microsoft.com/en-us/appcenter/retirement -const VisualStudioAppCenterReleasesSize = deprecatedService({ +const VisualStudioAppCenterReleasesSize = retiredService({ category: 'size', route: { base: 'visual-studio-app-center/releases/size', diff --git a/services/visual-studio-app-center/visual-studio-app-center-releases-version.service.js b/services/visual-studio-app-center/visual-studio-app-center-releases-version.service.js index fd3181ab46..ccfb5fcd5b 100644 --- a/services/visual-studio-app-center/visual-studio-app-center-releases-version.service.js +++ b/services/visual-studio-app-center/visual-studio-app-center-releases-version.service.js @@ -1,7 +1,7 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' // Visual Studio App Center was retired. See: https://learn.microsoft.com/en-us/appcenter/retirement -const VisualStudioAppCenterReleasesVersion = deprecatedService({ +const VisualStudioAppCenterReleasesVersion = retiredService({ category: 'version', route: { base: 'visual-studio-app-center/releases/version', diff --git a/services/visual-studio-marketplace/visual-studio-marketplace.service.js b/services/visual-studio-marketplace/visual-studio-marketplace.service.js index 7712dd8eea..13dde92c19 100644 --- a/services/visual-studio-marketplace/visual-studio-marketplace.service.js +++ b/services/visual-studio-marketplace/visual-studio-marketplace.service.js @@ -1,4 +1,4 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' const dateAdded = new Date('2026-04-09') const label = 'visual-studio-marketplace' @@ -6,25 +6,25 @@ const pattern = ':various+' export default [ // Downloads / Installs - deprecatedService({ + retiredService({ category: 'downloads', route: { base: 'visual-studio-marketplace/d', pattern }, label, dateAdded, }), - deprecatedService({ + retiredService({ category: 'downloads', route: { base: 'visual-studio-marketplace/i', pattern }, label, dateAdded, }), - deprecatedService({ + retiredService({ category: 'downloads', route: { base: 'vscode-marketplace/d', pattern }, label, dateAdded, }), - deprecatedService({ + retiredService({ category: 'downloads', route: { base: 'vscode-marketplace/i', pattern }, label, @@ -32,13 +32,13 @@ export default [ }), // Version - deprecatedService({ + retiredService({ category: 'version', route: { base: 'visual-studio-marketplace/v', pattern }, label, dateAdded, }), - deprecatedService({ + retiredService({ category: 'version', route: { base: 'vscode-marketplace/v', pattern }, label, @@ -46,25 +46,25 @@ export default [ }), // Rating / Stars - deprecatedService({ + retiredService({ category: 'rating', route: { base: 'visual-studio-marketplace/r', pattern }, label, dateAdded, }), - deprecatedService({ + retiredService({ category: 'rating', route: { base: 'visual-studio-marketplace/stars', pattern }, label, dateAdded, }), - deprecatedService({ + retiredService({ category: 'rating', route: { base: 'vscode-marketplace/r', pattern }, label, dateAdded, }), - deprecatedService({ + retiredService({ category: 'rating', route: { base: 'vscode-marketplace/stars', pattern }, label, @@ -72,25 +72,25 @@ export default [ }), // Release date / Last updated - deprecatedService({ + retiredService({ category: 'activity', route: { base: 'visual-studio-marketplace/release-date', pattern }, label, dateAdded, }), - deprecatedService({ + retiredService({ category: 'activity', route: { base: 'vscode-marketplace/release-date', pattern }, label, dateAdded, }), - deprecatedService({ + retiredService({ category: 'activity', route: { base: 'visual-studio-marketplace/last-updated', pattern }, label, dateAdded, }), - deprecatedService({ + retiredService({ category: 'activity', route: { base: 'vscode-marketplace/last-updated', pattern }, label, @@ -98,7 +98,7 @@ export default [ }), // Azure DevOps installs (covers measure/extensionId segments) - deprecatedService({ + retiredService({ category: 'downloads', route: { base: 'visual-studio-marketplace/azure-devops/installs', pattern }, label, diff --git a/services/visual-studio-marketplace/visual-studio-marketplace.tester.js b/services/visual-studio-marketplace/visual-studio-marketplace.tester.js index c7ae44a8a9..7f7d70d5fe 100644 --- a/services/visual-studio-marketplace/visual-studio-marketplace.tester.js +++ b/services/visual-studio-marketplace/visual-studio-marketplace.tester.js @@ -2,13 +2,13 @@ import { ServiceTester } from '../tester.js' export const t = new ServiceTester({ id: 'visualstudiomarketplace', - title: 'Visual Studio Marketplace (deprecated)', + title: 'Visual Studio Marketplace (retired)', pathPrefix: '/visual-studio-marketplace', }) export const tLegacy = new ServiceTester({ id: 'visualstudiomarketplacelegacy', - title: 'VSCode Marketplace (deprecated)', + title: 'VSCode Marketplace (retired)', pathPrefix: '/vscode-marketplace', }) diff --git a/services/wikiapiary/wikiapiary-installs.service.js b/services/wikiapiary/wikiapiary-installs.service.js index 952d2f5e86..39a284f6b4 100644 --- a/services/wikiapiary/wikiapiary-installs.service.js +++ b/services/wikiapiary/wikiapiary-installs.service.js @@ -1,6 +1,6 @@ -import { deprecatedService } from '../index.js' +import { retiredService } from '../index.js' -export default deprecatedService({ +export default retiredService({ category: 'downloads', route: { base: 'wikiapiary',