Skip to content

Commit 3c5fa3b

Browse files
DanielRaapDevDanielRaapDev
committed
Merge branch 'main' into SALI-7187_add_gateway_route
2 parents 9f61090 + 6cdc482 commit 3c5fa3b

File tree

4 files changed

+154
-0
lines changed

4 files changed

+154
-0
lines changed

‎charts/decisions/0000-versioning and changes.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Version Changes to Helm Charts
2+
3+
| <!-- --> | <!-- --> |
4+
|-----------|-------------------------------------------------------------|
5+
| status | accepted |
6+
| date | ? |
7+
| deciders | subshell |
8+
| consulted | ? |
9+
| informed | subshell developers |
10+
| <!-- --> | <!-- --> |
11+
12+
## Context and Problem Statement
13+
14+
Each Helm chart has a version. When changing charts the version must be updated to make the change clear.
15+
16+
The GitHub pipeline is triggered for all changed files on the main branch. To release these changes a unique version number must be set.
17+
18+
## Decision Outcome
19+
20+
We use semantic versioning in our Helm charts. All feature branches and pull requests must increment the chart version of all modified charts.
21+
22+
Increment the patch version for small fixes and documentation updates. Increment the minor version for added features. The major version should be incremented for breaking changes like removing or renaming values to indicate that they are not compatible with the previous major version.

‎charts/decisions/0001-changes annotation.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Use Artifacthub changes annotation as changelog
2+
3+
| <!-- --> | <!-- --> |
4+
|-----------|-------------------------------------------------------------|
5+
| status | accepted |
6+
| date | ? |
7+
| deciders | subshell Team Koala |
8+
| consulted | ? |
9+
| informed | subshell developers |
10+
| <!-- --> | <!-- --> |
11+
12+
## Context and Problem Statement
13+
14+
On Artifacthub our Helm charts get a nice website. To have a nice changelog it is possible to create it by an annotation.
15+
16+
## Decision Outcome
17+
18+
We use the annotation `artifacthub.io/changes` in all our Chart.yaml files to document the changes of the current version.
19+
20+
It contains a string with YAML. We prefer the structured form where the `kind` is given. Possible kinds:
21+
22+
- added
23+
- changed
24+
- deprecated
25+
- removed
26+
- fixed
27+
- security
28+
29+
## Example
30+
31+
```yaml
32+
name: example
33+
version: 1.1.0
34+
annotations:
35+
artifacthub.io/changes: |
36+
- kind: added
37+
description: "Added HTTPRoute support for Gateway API"
38+
```
39+
40+
This describes the changes that are contained in the version `1.1.0` only.
41+
42+
## More Information
43+
44+
- https://blog.artifacthub.io/blog/changelogs/
45+
- https://artifacthub.io/docs/topics/annotations/helm/#supported-annotations

‎charts/decisions/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Decisions
2+
3+
This directory contains decision records for helm-charts.
4+
5+
For new ADRs, please use [adr-template.md](adr-template.md) as basis.
6+
More information on MADR is available at <https://adr.github.io/madr/>.
7+
General information about architectural decision records is available at <https://adr.github.io/>.

‎charts/decisions/adr-template.md‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# {short title of solved problem and solution}
2+
3+
| <!-- --> | <!-- --> |
4+
|-----------|-------------------------------------------------------------|
5+
| status | {proposedrejected &#124; accepted &#124; deprecated &#124; … &#124; superseded by [ADR-0005](0005-example.md)} | |
6+
| date | {YYYY-MM-DD when the decision was last updated} |
7+
| deciders | {list everyone involved in the decision} |
8+
| consulted | {list everyone whose opinions are sought (typically subject-matter experts); and with whom there is a two-way communication} |
9+
| informed | {list everyone who is kept up-to-date on progress; and with whom there is a one-way communication} |
10+
| <!-- --> | <!-- --> |
11+
12+
## Context and Problem Statement
13+
14+
{Describe the context and problem statement, e.g., in free form using two to three sentences or in the form of an illustrative story.
15+
You may want to articulate the problem in form of a question and add links to collaboration boards or issue management systems.}
16+
17+
<!-- This is an optional element. Feel free to remove. -->
18+
## Decision Drivers
19+
20+
* {decision driver 1, e.g., a force, facing concern, …}
21+
* {decision driver 2, e.g., a force, facing concern, …}
22+
* … <!-- numbers of drivers can vary -->
23+
24+
## Considered Options
25+
26+
* {title of option 1}
27+
* {title of option 2}
28+
* {title of option 3}
29+
* … <!-- numbers of options can vary -->
30+
31+
## Decision Outcome
32+
33+
Chosen option: "{title of option 1}", because
34+
{justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | … | comes out best (see below)}.
35+
36+
<!-- This is an optional element. Feel free to remove. -->
37+
### Consequences
38+
39+
* Good, because {positive consequence, e.g., improvement of one or more desired qualities, …}
40+
* Bad, because {negative consequence, e.g., compromising one or more desired qualities, …}
41+
* … <!-- numbers of consequences can vary -->
42+
43+
<!-- This is an optional element. Feel free to remove. -->
44+
## Validation
45+
46+
{describe how the implementation of/compliance with the ADR is validated. E.g., by a review or an ArchUnit test}
47+
48+
<!-- This is an optional element. Feel free to remove. -->
49+
## Pros and Cons of the Options
50+
51+
### {title of option 1}
52+
53+
<!-- This is an optional element. Feel free to remove. -->
54+
{example | description | pointer to more information | …}
55+
56+
* Good, because {argument a}
57+
* Good, because {argument b}
58+
<!-- use "neutral" if the given argument weights neither for good nor bad -->
59+
* Neutral, because {argument c}
60+
* Bad, because {argument d}
61+
* … <!-- numbers of pros and cons can vary -->
62+
63+
### {title of other option}
64+
65+
{example | description | pointer to more information | …}
66+
67+
* Good, because {argument a}
68+
* Good, because {argument b}
69+
* Neutral, because {argument c}
70+
* Bad, because {argument d}
71+
* …
72+
73+
<!-- This is an optional element. Feel free to remove. -->
74+
## More Information
75+
76+
{You might want to provide additional evidence/confidence for the decision outcome here and/or
77+
document the team agreement on the decision and/or
78+
define when this decision when and how the decision should be realized and if/when it should be re-visited and/or
79+
how the decision is validated.
80+
Links to other decisions and resources might here appear as well.}

0 commit comments

Comments
 (0)