Skip to content

Commit

Permalink
docs(security): simplify the end of life process
Browse files Browse the repository at this point in the history
  • Loading branch information
rlespinasse committed Oct 20, 2023
1 parent d1ca8ff commit e5042e7
Showing 1 changed file with 10 additions and 13 deletions.
23 changes: 10 additions & 13 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,22 @@

## Supported Versions and Branches

We only support 2 major versions for security patches

| Version | Branch | Supported | Specific Tags |
| ------- | ------ | ------------------ | ------------- |
| 4.x | v4.x | :white_check_mark: | v4 |
| 3.x | v3.x | :white_check_mark: | |
| < 2.x | | :x: | v2.x, v1.1.x |
| Version | Supported | End of Support | Branch | Specific Tags |
| ------- | ------------------ | -------------- | ------ | ------------- |
| 4.x | :white_check_mark: | | v4.x | v4 |
| 3.x | :white_check_mark: | 2024-01-31 | v3.x | v3 |
| 2.x | :x: | 2021-04-05 | | v2.x, 2.2.0 |
| 1.x | :x: | 2021-04-05 | | v1.1.x, 1.2.0 |
| 1.0.x | :x: | 2019-11-07 | | 1.0.2 |

A GitHub repository can used one of the available branches as action inside its workflows.

### End of Life of a branch

When a branch is not supported anymore, the following process occurs
Since `2023-10-20`, when a new major version is release,

- Since `v4.x` branch, the branch will be deleted 2 major versions after
- So `v4.x` branch will be deleted when `v7.x` branch will have its first release
- prefer the `v4` tag to `v4.x` branch as reference in our workflow,
- Before `v4.x` branch, the branch will be converted into a tag when the support is dropped
- So `v3.x` branch will be converted as tag when `v5.x` branch will have its first release
- The previous one will continue to receive security patches during a 3-months periods,
- After the 3-month periods, the branch is deleted, only the tags remains.

## Reporting a Vulnerability

Expand Down

0 comments on commit e5042e7

Please sign in to comment.