@@ -42,41 +42,41 @@ Additional information can be found in the [contributing guide](./CONTRIBUTING.m
...
@@ -42,41 +42,41 @@ Additional information can be found in the [contributing guide](./CONTRIBUTING.m
- Big Bang releases adopt a standardized versioning based on and loosely following the [Semantic Versioning 2.0.0 guidelines](https://semver.org/spec/v2.0.0.html)(major.minor.patch). These releases aren't based on a fixed schedule and instead the specifics in the scheme are as follows:
- Big Bang releases adopt a standardized versioning based on and loosely following the [Semantic Versioning 2.0.0 guidelines](https://semver.org/spec/v2.0.0.html)(major.minor.patch). These releases aren't based on a fixed schedule and instead the specifics in the scheme are as follows:
### Patch Version
### Patch Version
A patch version increment is performed when there is a change in the tag (version number) of a Big Bang core package or a
A patch version increment is performed when there is a change in the tag (version number) of a Big Bang core package or a
bug fix for a Big Bang template or values files.
bug fix for a Big Bang template or values files.
A change in the patch version number should be backwards compatible
A change in the patch version number should be backwards compatible
with previous patch changes within a minor version. If there is a significant functionality change in the
with previous patch changes within a minor version. If there is a significant functionality change in the
a core package that requires adjustments to Big Bang templates, this would require a change in the minor or major version
a core package that requires adjustments to Big Bang templates, this would require a change in the minor or major version
depending on the impact to the values and secrets used to integrated the package with Big Bang.
depending on the impact to the values and secrets used to integrated the package with Big Bang.
NOTE: Patch versions would not typically be created for addon package updates, rather customers would be expected to be
NOTE: Patch versions would not typically be created for addon package updates, rather customers would be expected to be
updating those packages via `git.tag`/`helmRepo.tag` changes directly, or "inheriting" those updates through another version.
updating those packages via `git.tag`/`helmRepo.tag` changes directly, or "inheriting" those updates through another version.
### Minor Version
### Minor Version
A minor version increment is required when there is a change in the integration of Big Bang with core or addon packages.
A minor version increment is required when there is a change in the integration of Big Bang with core or addon packages.
As examples the following changes warrant a Minor version change:
As examples the following changes warrant a Minor version change:
- Change in the umbrella values.yaml (except for changes to package version keys)
- Change in the umbrella values.yaml (except for changes to package version keys)
- Change in any Big Bang templates (non bug fix changes)
- Change in any Big Bang templates (non bug fix changes)
Minor version changes should be backwards compatible.
Minor version changes should be backwards compatible.
### Major Version
### Major Version
A major version increment indicates a release that has significant changes, which could potentially break
A major version increment indicates a release that has significant changes, which could potentially break
compatibility with previous versions. A major change is required when there are changes to the architecture of Big Bang or
compatibility with previous versions. A major change is required when there are changes to the architecture of Big Bang or
critical values file keys. For example removing a core package or changing significant values that propagate to all core
critical values file keys. For example removing a core package or changing significant values that propagate to all core
and add-on packages are considered major version changes. As examples of major version changes:
and add-on packages are considered major version changes. As examples of major version changes:
- Removal or renaming of Big Bang values.yaml top level keys (e.g., istio, git repository values, etc.)
- Removal or renaming of Big Bang values.yaml top level keys (e.g., istio, git repository values, etc.)
- Change to the structure of chart/templates files or key values.
- Change to the structure of chart/templates files or key values.
- Additional integration between core/add-on packages that require change to the charts of all packages.
- Additional integration between core/add-on packages that require change to the charts of all packages.
- Modification of Big Bang GitOps engine (i.e. switching from FluxCD -> ArgoCD)
- Modification of Big Bang GitOps engine (i.e. switching from FluxCD -> ArgoCD)
- To see what is on the roadmap or included in a given release you can still review our [project milestones](https://repo1.dso.mil/groups/big-bang/-/milestones)
To see what is on the roadmap or included in a given release you can still review our [project milestones](https://repo1.dso.mil/groups/big-bang/-/milestones)
@@ -64,7 +64,7 @@ The following is a general overview of the process, the [deployment guides](./gu
...
@@ -64,7 +64,7 @@ The following is a general overview of the process, the [deployment guides](./gu
## New User Orientation
## New User Orientation
* New users are encouraged to read through the Useful Background Contextual Information present in the [understanding-bigbang folder](./understanding-bigbang)
* New users are encouraged to read through the Useful Background Contextual Information present in the [Understanding Big Bang Section](./understanding-bigbang)