Skip to content

Commit a812f6e

Browse files
committed
Update docs
1 parent e3603db commit a812f6e

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

docs/CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,34 @@ a regexp (Java format) matching the version pattern. For example, for the exampl
153153
}
154154
```
155155

156+
The optional `skipped-versions` key can be used to explicitly exclude specific
157+
library versions from being considered as supported metadata. A skipped version
158+
should include both the version and the reason it is excluded. This is useful
159+
when a version exists in Maven but is known to be broken, incompatible, or
160+
should be omitted from testing for any other reason. An example of the library
161+
above using this field:
162+
163+
```json
164+
{
165+
"metadata-version": "1.0.0",
166+
"module": "org.example:library",
167+
"tested-versions": [
168+
"1.0.0",
169+
"1.1.0"
170+
],
171+
"skipped-versions": [
172+
{
173+
"version": "1.0.5",
174+
"reason": "Known incompatible API change."
175+
},
176+
{
177+
"version": "1.0.7",
178+
"reason": "Resource metadata provided in reflect-config.json."
179+
}
180+
]
181+
}
182+
```
183+
156184
You can also list each supported version is listed in `tested-versions`, as that value is used in build tools to match
157185
metadata to a specific library, but this is more likely to break when new versions are released.
158186
Every metadata for a specific library version has a `index.json`. For this

0 commit comments

Comments
 (0)