Skip to content

Commit

Permalink
add versioning page (#42)
Browse files Browse the repository at this point in the history
  • Loading branch information
noel authored Sep 16, 2024
1 parent fb316ed commit 98fc2ad
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,8 @@
- [DAG Generators](/reference/airflow/dag-generators.md)
- [Datacoves Operators](/reference/airflow/datacoves-operator.md)
- [Datacoves](/reference/datacoves/)
- [VPC Deployment](/reference/datacoves/vpc-deployment.md)
- [Versioning](/reference/datacoves/versioning.md)
- [VPC Deployment](/reference/datacoves/vpc-deployment.md)
- [Metrics & Logs](/reference/metrics-and-logs/)
- [Grafana](/reference/metrics-and-logs/grafana.md)
- [Security](/reference/security/)
Expand Down
40 changes: 40 additions & 0 deletions docs/reference/datacoves/versioning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Datacoves versioning

Datacoves uses [semantic versioning](https://semver.org/) in all our docker images, and Datacoves releases.

`MAJOR.MINOR.PATCH`

The `MAJOR.MINOR` versions are defined as below and `PATCH` is an autogenerated (timestamp) generated when the release is built.

## Our criteria

### When do we bump the `MAJOR` version?

When we make incompatible changes or we introduce compatible changes but deprecate features:

- Any python library upgrade (including dbt) that requires changes in the customer's analytics(dbt) git repo
- Airbyte, Airflow, DataHub, Superset upgrades that require reconfiguration
- Datacoves core changes that require human intervention
- Airbyte, Airflow, DataHub, Superset that do not require reconfiguration, but several features are being deprecated

### When should we bump the `MINOR` version?

- When we make compatible changes, such as new features or upgrade dependencies
- Patch version changes to dbt e.g. 1.8.3 to 1.8.5
- Compatible updates to dbt e.g. 1.7.x to 1.8.x
- Compatible update to Airbyte, Airflow, DataHub, Superset that do not require reconfiguration

### Everything else is a `PATCH`

- Bug fixes, performance enhancements

## Images tags

Images are pushed with the folling tags:

- MAJOR
- MAJOR.MINOR
- MAJOR.MINOR.PATCH
- MAJOR.MINOR.PATCH-\<commit sha\>

CI jobs that use Datacoves images could reference any of the above, depending on how specific the customer needs to be.

0 comments on commit 98fc2ad

Please sign in to comment.