UNCLASSIFIED - NO CUI

Skip to content
Snippets Groups Projects
Commit bea59eec authored by Andrew Greene's avatar Andrew Greene
Browse files

docs: Correct versioning scheme

parent 228902ac
No related branches found
No related tags found
1 merge request!3feat: Upgrade from upstream CDI v1.53.0
Pipeline #925004 passed
This commit is part of merge request !3. Comments created here will be created in the context of that merge request.
......@@ -2,7 +2,7 @@
Format: [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
## [0.1.0-bb.0] - 2022-08-12
## [1.53.0-bb.0] - 2022-08-12
### Changed
- Updated from upstream CDI v1.53.0
......
# cdi-operator
![Version: 0.1.0-bb.0](https://img.shields.io/badge/Version-0.1.0--bb.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.53.0](https://img.shields.io/badge/AppVersion-1.53.0-informational?style=flat-square)
![Version: 1.53.0-bb.0](https://img.shields.io/badge/Version-1.53.0--bb.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.53.0](https://img.shields.io/badge/AppVersion-1.53.0-informational?style=flat-square)
Containerized Data Importer helm chart package
......
......@@ -2,5 +2,5 @@ apiVersion: v2
name: cdi-operator
description: Containerized Data Importer helm chart package
type: application
version: 0.1.0-bb.0
version: 1.53.0-bb.0
appVersion: "1.53.0"
# Versioning
This Big Bang package for CDI is a derivation of the upstream CDI manifests. As such, there is the version of this Big Bang package and the version of the upstream CDI manifests/project.
This Big Bang project version is a combination of the upstream project's semantic version and the "big-bang version".
Whenever the upstream project is updated, the semantic version value of `chart/Chart.yaml` `version` and `appVersion`
keys will also be updated. The `big-bang version` (i.e. x.y.z-bb.N) will be updated for all other changes to the chart.
This project has adopted the following versioning scheme:
1. Major Version (i.e. v1.X.Y-bb.Z to v2.X.Y-bb.Z)
1. Maintainers will handle major version changes as needed.
1Minor Version (i.e. vX.1.y-bb.z to vX.2.y-bb.z)
1. minor version will be incremented when the upstream project version is incremented. (i.e. upstream project v0.54.0 to v0.55.0, would result in v0.1.0-bb.0 to v0.2.0-bb.0)
1. Patch Version (i.e. vX.Y.1-bb.z to vX.Y.2-bb.z)
1. patch version will increment when the upstream project patch version is incremented. (i.e. upstream project v0.54.0 to v0.54.1, would result in v0.1.0-bb.0 to v0.1.0-bb.1)
1. Big Bang Version (i.e. vX.Y.Z-bb.0 to vX.Y.Z-bb.1)
1. big bang version will increment when this project is updated. (i.e. this project v0.1.0-bb.0 to v0.1.0-bb.1)
1. Helm Chart Application Version
1. application version will always match the upstream project version.
2. All other versioning will be discussed by the project maintainers.
Examples:
| Upstream Version | Package Version | Change |
| ------- | ---------------- | ------- |
| 0.0.1 | 0.0.1-bb.0 | N/A |
| 0.0.2 | 0.0.2-bb.0 | Upstream version Update |
| 0.0.2 | 0.0.2-bb.1 | Big Bang Package Update |
| 0.0.2 | 0.0.2-bb.2 | Big Bang Package Update |
| 1.4.5 | 1.4.5-bb.0 | Multiple Upstream Version Updates |
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment