Skip to content

Commit

Permalink
OPSEXP-2460: update README to reflect new release policy (#1105)
Browse files Browse the repository at this point in the history
  • Loading branch information
@alxgomz
alxgomz authored Mar 1, 2024
1 parent f6db569 commit 4db0437
Showing 1 changed file with 44 additions and 67 deletions.
111 changes: 44 additions & 67 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,73 +49,50 @@ account.

## Versioning

The master branch of this repository now contains the artifacts required to
deploy both the the latest work-in-progress development version and previous
stable versions of ACS that are still supported.

During the development phase, one or more milestone releases will be produced
indicated by an `-M` suffix, for example `6.0.0-M.1``. Once an ACS version
become GA, also a GA release of this repository will be published.

The table below shows the exact version of ACS deployed with each chart version/tag.

| Chart Version/Tag | Default | 7.4.N | 7.3.N | 7.2.N | 7.1.N | 7.0.N | Community |
|------------------------|------------|---------|---------|----------|----------|----------|-----------|
| 5.0.0-M1 | 7.0.0-M2 | | | | | | 6.2.1-A8 |
| 5.0.0-M2 | 7.0.0-M3 | | | | | | 7.0.0 |
| 5.0.0 | 7.0.0 | | | | | | 7.0.0 |
| [5.0.1][5.0.1] | 7.0.0 | | | | | | 7.0.0 |
| 5.1.0-M1 | 7.1.0-M1 | | | | | | 7.1.0-M1 |
| 5.1.0-M2 | 7.1.0-M2 | | | | | 7.0.1 | 7.1.0-M2 |
| 5.1.0 | 7.1.0.1 | | | | | 7.0.1 | 7.1.0 |
| [5.1.1][5.1.1] | 7.1.0.1 | | | | | 7.0.1 | 7.1.0 |
| 5.2.0-M1 | 7.2.0-M1 | | | | 7.1.0.1 | 7.0.1 | 7.2.0-M1 |
| 5.2.0-M2 | 7.2.0-M2 | | | | 7.1.1 | 7.0.1 | 7.2.0-M2 |
| [5.2.0][5.2.0] | 7.2.0 | | | | 7.1.1 | 7.0.1 | 7.2.0 |
| 5.3.0-M1 | 23.1.0-M1 | | | 7.2.1 | 7.1.1.5 | 7.0.1.3 | 23.1.0-M1 |
| 5.3.0-M2 | 7.3.0-M1 | | | 7.2.1 | 7.1.1.5 | 7.0.1.3 | 7.3.0-M2 |
| 5.3.0-M3 | 7.3.0-M2 | | | 7.2.1 | 7.1.1.5 | 7.0.1.3 | 7.3.0-M2 |
| [5.3.0][5.3.0] | 7.3.0 | | | 7.2.1 | 7.1.1.5 | 7.0.1.3 | 7.3.0 |
| 5.4.0-M1 | 7.4.0-M1 | | 7.3.0.1 | 7.2.1.5 | 7.1.1.7 | 7.0.1.9 | 7.4.0-M1 |
| 5.4.0-M2 | 7.4.0-M2 | | 7.3.1 | 7.2.1.7 | 7.1.1.8 | 7.0.1.10 | 7.4.0-M2 |
| 5.4.0-M3 | 7.4.0-M3 | | 7.3.1 | 7.2.1.7 | 7.1.1.8 | 7.0.1.10 | 7.4.0-M3 |
| [6.0.0][6.0.0] | 7.4.0.1 | | 7.3.1 | 7.2.1.11 | 7.1.1.8 | 7.0.1.10 | 7.4.0.1 |
| [6.0.1][6.0.1] | 7.4.0.1 | | 7.3.1 | 7.2.1.11 | 7.1.1.8 | 7.0.1.10 | 7.4.0.1 |
| [6.0.2][6.0.2] | 7.4.0.1 | | 7.3.1 | 7.2.1.11 | 7.1.1.8 | 7.0.1.10 | 7.4.0.1 |
| [6.1.0-M.1][6.1.0-M.1] | 23.1.0-A19 | 7.4.0.1 | 7.3.1 | 7.2.1.11 | 7.1.1.8 | 7.0.1.10 | 7.4.0.1 |
| [7.0.0-M.1][7.0.0-M.1] | 23.1.0-A27 | 7.4.1 | 7.3.1 | 7.2.1.12 | 7.1.1.8 | 7.0.1.10 | 7.4.1 |
| [7.0.0-M.2][7.0.0-M.2] | 23.1.0-M4 | 7.4.1.1 | 7.3.1 | 7.2.1.12 | 7.1.1.8 | 7.0.1.10 | 7.4.1.1 |
| [7.0.0][7.0.0] | 23.1.0 | 7.4.1.2 | 7.3.1.1 | 7.2.1.12 | 7.1.1.8 | 7.0.1.10 | 23.1.0 |
| [7.0.1][7.0.1] | 23.1.1 | 7.4.1.3 | 7.3.1.2 | 7.2.1.13 | 7.1.1.10 | 7.0.1.10 | 23.1.0 |
| [7.0.2][7.0.2] | 23.1.1 | 7.4.1.3 | 7.3.1.2 | 7.2.1.13 | 7.1.1.10 | 7.0.1.10 | 23.1.0 |
| [7.0.3][7.0.3] | 23.1.1 | 7.4.1.3 | 7.3.1.2 | 7.2.1.13 | 7.1.1.10 | 7.0.1.10 | 23.1.0 |
| [8.0.0-M.1][8.0.0-M.1] | 23.2.0-M1 | 7.4.1.3 | 7.3.1.2 | 7.2.1.13 | 7.1.1.10 | 7.0.1.10 | 23.1.0 |

[5.0.1]: https://github.com/Alfresco/acs-deployment/releases/tag/v5.0.1
[5.1.1]: https://github.com/Alfresco/acs-deployment/releases/tag/v5.1.1
[5.2.0]: https://github.com/Alfresco/acs-deployment/releases/tag/v5.2.0
[5.3.0]: https://github.com/Alfresco/acs-deployment/releases/tag/v5.3.0
[6.0.0]: https://github.com/Alfresco/acs-deployment/releases/tag/v6.0.0
[6.0.1]: https://github.com/Alfresco/acs-deployment/releases/tag/v6.0.1
[6.0.2]: https://github.com/Alfresco/acs-deployment/releases/tag/v6.0.2
[6.1.0-M.1]: https://github.com/Alfresco/acs-deployment/releases/tag/v6.1.0-M.1
[7.0.0-M.1]: https://github.com/Alfresco/acs-deployment/releases/tag/v7.0.0-M.1
[7.0.0-M.2]: https://github.com/Alfresco/acs-deployment/releases/tag/v7.0.0-M.2
[7.0.0]: https://github.com/Alfresco/acs-deployment/releases/tag/v7.0.0
[7.0.1]: https://github.com/Alfresco/acs-deployment/releases/tag/v7.0.1
[7.0.2]: https://github.com/Alfresco/acs-deployment/releases/tag/v7.0.2
[7.0.3]: https://github.com/Alfresco/acs-deployment/releases/tag/v7.0.3
[8.0.0-M.1]: https://github.com/Alfresco/acs-deployment/releases/tag/v8.0.0-M.1

### Why there is no 5.4.0?

During the development of 5.4.0 we've started moving individual components
templates (search, sync, activemq, ...) into individual charts on
[alfresco-helm-charts](https://github.com/Alfresco/alfresco-helm-charts). That
decision introduced some breaking changes like resource renaming and values
structure modifications that has been shipped since v6.0.0.

### End of Life'd versions
As of version 8.0.0 of the chart we have changed the release policy.
Previously, the chart was released together with the ACS product and we were
delivering additional values files for each major release of ACS (e.g. 7.3,
7.4, ...) and chart version were bumped with a similar increment as ACS.
With version 6.0.0, we started applying major versions bumps to reflect
breaking changes in the chart, despite only minor ACS release happened.

With 8.0.0 onward, the release pace of the chart is completely independent from
the product versions. We will also stick to Semver principles when choosing
next version number, meaning that:

* patch version will be used for bug fixes (last digit)
* minor version will be used for new features and modifications which do not
introduce breaking changes in the configuration interface.
* major version will be used for changes which involve breaking changes in the
configuration interface.

The `alfresco-content-services` chart has always provided the ability to deploy
any currently supported version of ACS and its components and will continue to
do so. You are encoraged to always use the latest version of the chart to
deploy your ACS version, using the appropriate values file. For that reason we
stop providing the table mapping chart versions with the ACS version they
deploy (by default). Instead we'll just maintain the list of deprecated versions
versions mapped with the latest versions of the charts we tested deployment
with, so you can use that version to deploy older ACS version on Kubernetes.
Check the [ACS End of Life'd versions](#acs-end-of-lifed-versions) paragraph.

You are encouraged to always use the latest version of the chart to deploy your
currently supported ACS version, using the appropriate values file.

Finally, the master branch of this repository used to contain the latest
versions, including non-released versions!
We're also moving away from this pattern and the chart will now only ever
deploy released versions of our products.

Should you want to try our latest dev versions, we now provide an additional
values file called `pre-release_values.yaml` which will be bumped on a regular
basis.

This also means we will not produce `-M*` versions of the chart anymore.

Check the [Release page](https://github.com/Alfresco/acs-deployment/releases) for the list of existing versions.

### ACS End of Life'd versions

While our latest version of the charts should be able to deployment any version
of ACS (theoretically), we only ever test deployment of _currently_ supported
Expand Down

0 comments on commit 4db0437

Please sign in to comment.