Skip to content

Commit 4685621

Browse files
committed
📝 update readme
1 parent 478cb29 commit 4685621

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,30 @@ In some cases, it may be unavoidable that a security fix involves a breaking cha
2222

2323
## Acceptance criteria for patched releases
2424

25-
- Wherever possible, reuse the existing patch code from patched jQuery releases
26-
- All existing passing tests must pass
25+
- All CVEs for the release MUST be patched
26+
- Wherever possible, reuse the existing patch code from patched official jQuery releases
27+
- All existing passing tests MUST pass
2728
- Additional unit/integration test coverage as needed to account for the changes
2829
- A/B end-to-end acceptance tests against the unpatched and patched versions for all CVEs
2930

30-
## Available patched releases
31+
## Patched releases
32+
33+
In a perfect world, at least every MAJOR EOL jQuery release line would have a security-patched release. "Major" refers to the meaning of the term in [SemVer](https://semver.org/), thus releases that have breaking changes. The goal is to provide a patched version of jQuery for all major release lines to provide a path of least resistance for all downstream users to upgrade to a secure version jQuery with [no (or minimal) breaking changes](#but-what-about-breaking-changes).
3134

3235
| jQuery version | jQuery-sec version | Branch | PR | Release |
3336
| -------------- | ------------------ | ------------------------- | -------------- | ------- |
34-
| 1.6.4 | 1.6.5-sec | [1.6.5-sec][1.6.5-branch] | [PR][1.6.5-pr] | TODO |
35-
36-
### Future releases
37-
38-
In a perfect world, at least every MAJOR jQuery release line would have a security-patched release. "Major" refers to the meaning of the term in [SemVer](https://semver.org/), thus releases that have breaking changes. The goal is to provide a patched version of jQuery for all major release lines to provide a path of least resistance for all downstream users to upgrade to a secure version jQuery with [no (or minimal) breaking changes](#but-what-about-breaking-changes).
37+
| `1.2.6` | `1.2.7-sec` | | | |
38+
| `1.3.2` | `1.3.3-sec` | | | |
39+
| `1.4.4` | `1.4.5-sec` | | | |
40+
| `1.5.2` | `1.5.3-sec` | | | |
41+
| `1.6.4` | `1.6.5-sec` | [1.6.5-sec][1.6.5-branch] | [PR][1.6.5-pr] | TODO |
42+
| `1.7.2` | `1.7.3-sec` | | | |
43+
| `1.8.3` | `1.8.4-sec` | | | |
44+
| `1.12.4` | `1.12.5-sec` | | | |
45+
| `2.2.4` | `2.2.5-sec` | | | |
46+
47+
> [!NOTE]
48+
> The 3.x release line is currently supported by jQuery, so we have no need to provide patched versions of 3.x at this time. jQuery 3.5 introduced a breaking change, but it was necessary to fix CVE-2020-11022 and CVE-2020-11023. However, since these vulnerabilities are present in virtually all versions of jQuery, there would be no value in providing a patched version of 3.4 as it would need to include that breaking change anyway.
3949
4050
## Goals
4151

0 commit comments

Comments
 (0)