Skip to content

Commit 2bb0e6b

Browse files
committed
change deprecated badge messages to 'retired badge'
- reduce confusion over deprecated badge source (badge, shields, endpoint service, user's service) - reduce length of message to reduce traffic update all deprecated services and base class code in a follow-up commit after discussion. see #11792 (comment)
1 parent 94cc463 commit 2bb0e6b

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

doc/deprecating-badges.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,18 +46,18 @@ export const t = new ServiceTester({
4646
})
4747
```
4848

49-
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 `no longer available` (such as `imagelayers | no longer available`) so the tests need to be updated to reflect that message value. For example:
49+
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:
5050

5151
```js
52-
t.create('no longer available (previously image size)')
52+
t.create('retired badge (previously image size)')
5353
.get('/image-size/_/ubuntu/latest.json')
5454
.expectBadge({
5555
label: 'imagelayers',
56-
message: 'no longer available',
56+
message: 'retired badge',
5757
})
5858
```
5959

60-
Make sure to have a live (non-mocked) test for each badge the service provides that validates the each badge returns the `no longer available` message.
60+
Make sure to have a live (non-mocked) test for each badge the service provides that validates the each badge returns the `retired badge` message.
6161

6262
Here is an example of what the final result would look like for a test file:
6363

@@ -69,18 +69,18 @@ export const t = new ServiceTester({
6969
title: 'ImageLayers',
7070
})
7171

72-
t.create('no longer available (previously image size)')
72+
t.create('retired badge (previously image size)')
7373
.get('/image-size/_/ubuntu/latest.json')
7474
.expectBadge({
7575
label: 'imagelayers',
76-
message: 'no longer available',
76+
message: 'retired badge',
7777
})
7878

79-
t.create('no longer available (previously number of layers)')
79+
t.create('retired badge (previously number of layers)')
8080
.get('/layers/_/ubuntu/latest.json')
8181
.expectBadge({
8282
label: 'imagelayers',
83-
message: 'no longer available',
83+
message: 'retired badge',
8484
})
8585
```
8686

0 commit comments

Comments
 (0)