...
One Unique release consists of:
Artefact | Further Use | Format | Consumable | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Unique Product |
| Run Unique workloads with a container orchestrator | Multiple Docker Images | Either as files forked to own Git, tarballs or images from a private Azure Container registry | ||||||||||||
Connectors (On Premise and Cloud) |
| Upgrade local installations of various connectors to connect to the Unique Product | Multiple Docker Images | Either as files forked to own Git, tarballs or images from a private Azure Container registry | ||||||||||||
Helm Charts |
| In order to run Unique on Kubernetes, helm charts are the recommended way to render and apply Kubernetes manifests. | Multiple Helm | Either as files forked to own Git or tarballs from a private Azure Container registry | ||||||||||||
Helm Files |
| Mainly for inspiration as most clients have their own deployment infrastructure already. Enables customers (providing their own customisation) to deploy Unique Product upon a Kubernetes Cluster | YAML ( incl. 3rd party OSS services + their config as code | As files forked to own Git | ||||||||||||
Terraform modules |
| Terraform own Azure Landscape or just get inspired which components are needed | HCL for Azure | Either as files forked to own Git or published over Azure Container registry | ||||||||||||
SBOM Software Bill of Materials |
| For further analysis for customers, pinned to the current release | SPDX format incl. Grype Scan results | As files | ||||||||||||
Release notes |
| A change log for humans | Text | Public docs | ||||||||||||
Customisation examples |
| Customise each setup from example cases | YAML | Files forked to own Git, then overridden | ||||||||||||
Ferryman |
| A basic script to mirror images and helm charts from Unique to the Client, see Rollout Guidelines. | NodeJS CLI using https://oclif.io | Files forked to own Git |
...
You find them on various screens and they consist of a hexadecimal representation like 37cd467
cd47
.
In some versions they also include the pre-release information of the next FinanceGPT release, see below.
An example for Calendar Week 28 2024 would be; 2024.28-cd47
.
...
Bi-weekly release names
Our release names follow the simple pattern of
Code Block |
---|
<YYYY>-.<CW>(-.I) YYYY Year CW Calendar Week Padded I Numeric counter if fixes provided <YYYY>.<CW>(-SHA) YYYY Year CW Calendar Week Padded SHA Build version for continuous releases |
Examples are
Code Block |
---|
2023-.01 // padded 2023-.12 2023-.34 2023-.34-.1 // patch 1 2023-34-2 // patch 2 - shame on us to need two fixes |
Note on the format
Expand | ||
---|---|---|
| ||
In Docker tags, it is conventional and recommended to use dots ( Here are a few reasons why dots are preferred over dashes:
While Docker allows a degree of flexibility in naming tags (including using dashes), sticking with dots for versioning tags promotes clarity and consistency, which are crucial in software development and deployment workflows. Therefore, it's generally better to use dots ( |
Expand | ||
---|---|---|
| ||
To create a Docker tag that includes the components YYYY (year), CW (calendar week), and a 6-character Git short SHA, you can use a delimiter to separate these components clearly. Given the nature of Docker tags and to ensure readability and consistency, a suitable format would be:
Here's what each component represents:
Example If today is July 11, 2024, and the Git short SHA is
Explanation of the format
Advantages of this format
By following this format ( Collisions risk The collision risk depends on the probability of two different commits having the same short SHA within the same calendar week. Let's break down the components:
Calculating Collision Probability For 3-character SHA:
For 4-character SHA:
Recommendation Using a 4-character SHA reduces the collision risk significantly compared to a 3-character SHA and is generally sufficient for most practical purposes. |
Release Notes
Release notes are always published before a release is being provided on Release Notes
...