Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
| Readme | Chart Version | App Version | Description | Hub |
|--------|---------------|-------------|-------------|-----|
| [Agent](./charts/agent/README.md) | 2.4.0 |v2.2.0 | Formance Membership Agent Helm Chart | [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/agent)](https://artifacthub.io/packages/search?repo=agent) |
| [Cloudprem](./charts/cloudprem/README.md) | 2.1.1 |v0.36.2 | Formance control-plane | [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/cloudprem)](https://artifacthub.io/packages/search?repo=cloudprem) |
| [Console](./charts/console/README.md) | 1.1.0 |fccc26c5b568781b86fbd06c651399c0edd67bac | Formance Console | [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/console)](https://artifacthub.io/packages/search?repo=console) |
| [Console-V3](./charts/console-v3/README.md) | 1.1.0 |368ae6f5bd0a51bd5d9ebc0248a866869df5e326 | Formance Console | [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/console-v3)](https://artifacthub.io/packages/search?repo=console-v3) |
| [Cloudprem](./charts/cloudprem/README.md) | 2.2.0 |v0.36.2 | Formance control-plane | [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/cloudprem)](https://artifacthub.io/packages/search?repo=cloudprem) |
| [Console](./charts/console/README.md) | 1.2.0 |fccc26c5b568781b86fbd06c651399c0edd67bac | Formance Console | [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/console)](https://artifacthub.io/packages/search?repo=console) |
| [Console-V3](./charts/console-v3/README.md) | 1.2.0 |368ae6f5bd0a51bd5d9ebc0248a866869df5e326 | Formance Console | [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/console-v3)](https://artifacthub.io/packages/search?repo=console-v3) |
| [Core](./charts/core/README.md) | 1.1.0 |latest | Formance Core Library | [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/core)](https://artifacthub.io/packages/search?repo=core) |
| [Demo](./charts/demo/README.md) | 2.1.0 |latest | Formance Private Regions Demo | [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/demo)](https://artifacthub.io/packages/search?repo=demo) |
| [Membership](./charts/membership/README.md) | 1.1.1 |v0.36.2 | Formance Membership API. Manage stacks, organizations, regions, invitations, users, roles, and permissions. | [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/membership)](https://artifacthub.io/packages/search?repo=membership) |
| [Portal](./charts/portal/README.md) | 1.1.0 |191a441519a65dae56a5b2cf56fe64eee03fc059 | Formance Portal | [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/portal)](https://artifacthub.io/packages/search?repo=portal) |
| [Membership](./charts/membership/README.md) | 1.2.0 |v0.36.2 | Formance Membership API. Manage stacks, organizations, regions, invitations, users, roles, and permissions. | [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/membership)](https://artifacthub.io/packages/search?repo=membership) |
| [Portal](./charts/portal/README.md) | 1.2.0 |191a441519a65dae56a5b2cf56fe64eee03fc059 | Formance Portal | [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/portal)](https://artifacthub.io/packages/search?repo=portal) |
Comment on lines +8 to +14
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Annotations implementation is incomplete and undocumented

  • The annotations property is only defined in cloudprem and console-v3 charts, missing in others
  • Documentation for the new annotations feature is missing in all chart README files
🔗 Analysis chain

Verify version bump consistency across charts.

The version increments follow semantic versioning and appear appropriate for adding new features. However, let's verify the changes are consistent across all chart files.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify version updates and annotations property in chart files

# Check version updates in Chart.yaml files
for chart in cloudprem console console-v3 membership portal; do
  echo "Checking $chart Chart.yaml:"
  cat "./charts/$chart/Chart.yaml" | grep -E "version:|annotations:"
done

# Check for annotations documentation in README files
for chart in cloudprem console console-v3 membership portal; do
  echo "Checking $chart README.md for annotations documentation:"
  grep -A 5 "annotations:" "./charts/$chart/README.md" || echo "No annotations documentation found"
done

Length of output: 2904

🧰 Tools
🪛 LanguageTool

[style] ~13-~13: Using many exclamation marks might seem excessive (in this case: 10 exclamation marks for a text that’s 3034 characters long)
Context: ...tions, users, roles, and permissions. | Artifact HUB | | Portal | 1.2.0 |191a441519a65dae56a5b2cf56fe64eee03fc059 | Formance Portal | Artifact HUB | | Regions | 2.7.0 |latest | Formance Private Regions Helm Chart | Artifact HUB | | Stargate | 0.6.0 |latest | Formance Stargate gRPC Gateway | [![Artifact HUB](https://img.shields.io/en...

(EN_EXCESSIVE_EXCLAMATION)

| [Regions](./charts/regions/README.md) | 2.7.0 |latest | Formance Private Regions Helm Chart | [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/regions)](https://artifacthub.io/packages/search?repo=regions) |
| [Stargate](./charts/stargate/README.md) | 0.6.0 |latest | Formance Stargate gRPC Gateway | [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/stargate)](https://artifacthub.io/packages/search?repo=stargate) |

Expand Down
12 changes: 6 additions & 6 deletions charts/cloudprem/Chart.lock
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
dependencies:
- name: membership
repository: file://../membership
version: 1.1.1
version: 1.2.0
- name: portal
repository: file://../portal
version: 1.1.0
version: 1.2.0
- name: console
repository: file://../console
version: 1.1.0
version: 1.2.0
- name: console-v3
repository: file://../console-v3
version: 1.1.0
digest: sha256:e88c7127b6723d7c606eca8e585bc0ddafa9f15d757e232c6f7b8c6472711df8
generated: "2025-01-08T10:12:14.612747+01:00"
version: 1.2.0
digest: sha256:ae6941345e91831d1538089a8133d86e9f6ba604f405fb8bc886b1d9e21fa417
generated: "2025-01-13T13:56:49.416829+01:00"
2 changes: 1 addition & 1 deletion charts/cloudprem/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 2.1.1
version: 2.2.0

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
Expand Down
6 changes: 5 additions & 1 deletion charts/cloudprem/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/cloudprem)](https://artifacthub.io/packages/search?repo=cloudprem)
![Version: 2.1.1](https://img.shields.io/badge/Version-2.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.36.2](https://img.shields.io/badge/AppVersion-v0.36.2-informational?style=flat-square)
![Version: 2.2.0](https://img.shields.io/badge/Version-2.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.36.2](https://img.shields.io/badge/AppVersion-v0.36.2-informational?style=flat-square)

# Formance Cloudprem Helm Chart

Expand Down Expand Up @@ -462,6 +462,7 @@ Dex:
| global.platform.membership.oidc.scheme | string | `"https"` | is the scheme for the issuer |
| global.platform.portal.cookie | object | `{"encryptionKey":"changeMe00","existingSecret":"","secretKeys":{"encryptionKey":""}}` | EXPERIMENTAL |
| console.affinity | object | `{}` | Console affinity |
| console.annotations | object | `{}` | Console annotations |
| console.autoscaling.enabled | bool | `false` | |
| console.autoscaling.maxReplicas | int | `100` | |
| console.autoscaling.minReplicas | int | `1` | |
Expand Down Expand Up @@ -510,6 +511,7 @@ Dex:
| console.volumeMounts | list | `[]` | Console volume mounts |
| console.volumes | list | `[]` | Console volumes |
| console-v3.affinity | object | `{}` | Console affinity |
| console-v3.annotations | object | `{}` | Console annotations |
| console-v3.autoscaling.enabled | bool | `false` | |
| console-v3.autoscaling.maxReplicas | int | `100` | |
| console-v3.autoscaling.minReplicas | int | `1` | |
Expand Down Expand Up @@ -559,6 +561,7 @@ Dex:
| console-v3.volumeMounts | list | `[]` | Console volume mounts |
| console-v3.volumes | list | `[]` | Console volumes |
| membership.affinity | object | `{}` | Membership affinity |
| membership.annotations | object | `{}` | Membership annotations |
| membership.autoscaling | object | `{}` | Membership autoscaling |
| membership.commonLabels | object | `{}` | DEPRECATED Membership service |
| membership.config.additionalEnv | list | `[]` | Additional Environment variables on the main deployment |
Expand Down Expand Up @@ -638,6 +641,7 @@ Dex:
| membership.volumeMounts | list | `[]` | Membership volume mounts |
| membership.volumes | list | `[]` | Membership volumes |
| portal.affinity | object | `{}` | Portal affinity |
| portal.annotations | object | `{}` | Portal annotations |
| portal.autoscaling.enabled | bool | `false` | |
| portal.autoscaling.maxReplicas | int | `100` | |
| portal.autoscaling.minReplicas | int | `1` | |
Expand Down
2 changes: 1 addition & 1 deletion charts/console-v3/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 1.1.0
version: 1.2.0

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
Expand Down
3 changes: 2 additions & 1 deletion charts/console-v3/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# console-v3

![Version: 1.1.0](https://img.shields.io/badge/Version-1.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 368ae6f5bd0a51bd5d9ebc0248a866869df5e326](https://img.shields.io/badge/AppVersion-368ae6f5bd0a51bd5d9ebc0248a866869df5e326-informational?style=flat-square)
![Version: 1.2.0](https://img.shields.io/badge/Version-1.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 368ae6f5bd0a51bd5d9ebc0248a866869df5e326](https://img.shields.io/badge/AppVersion-368ae6f5bd0a51bd5d9ebc0248a866869df5e326-informational?style=flat-square)

Formance Console

Expand Down Expand Up @@ -67,6 +67,7 @@ Kubernetes: `>=1.14.0-0`
|-----|------|---------|-------------|
| global.platform.portal.cookie | object | `{"encryptionKey":"changeMe00","existingSecret":"","secretKeys":{"encryptionKey":""}}` | EXPERIMENTAL |
| affinity | object | `{}` | Console affinity |
| annotations | object | `{}` | Console annotations |
| autoscaling.enabled | bool | `false` | |
| autoscaling.maxReplicas | int | `100` | |
| autoscaling.minReplicas | int | `1` | |
Expand Down
4 changes: 4 additions & 0 deletions charts/console-v3/templates/deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ metadata:
namespace: {{ .Release.Namespace }}
labels:
{{- include "core.labels" . | nindent 4 }}
annotations:
{{- with .Values.annotations }}
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
replicas: {{ .Values.replicas }}
selector:
Expand Down
4 changes: 4 additions & 0 deletions charts/console-v3/values.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
"properties": {},
"type": "object"
},
"annotations": {
"properties": {},
"type": "object"
},
"autoscaling": {
"properties": {
"enabled": {
Expand Down
3 changes: 3 additions & 0 deletions charts/console-v3/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,9 @@ ingress:
# -- Console volume mounts
volumeMounts: []

# -- Console annotations
annotations: {}

# -- Console volumes
volumes: []

Expand Down
2 changes: 1 addition & 1 deletion charts/console/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 1.1.0
version: 1.2.0

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
Expand Down
3 changes: 2 additions & 1 deletion charts/console/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# console

![Version: 1.1.0](https://img.shields.io/badge/Version-1.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: fccc26c5b568781b86fbd06c651399c0edd67bac](https://img.shields.io/badge/AppVersion-fccc26c5b568781b86fbd06c651399c0edd67bac-informational?style=flat-square)
![Version: 1.2.0](https://img.shields.io/badge/Version-1.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: fccc26c5b568781b86fbd06c651399c0edd67bac](https://img.shields.io/badge/AppVersion-fccc26c5b568781b86fbd06c651399c0edd67bac-informational?style=flat-square)

Formance Console

Expand Down Expand Up @@ -66,6 +66,7 @@ Kubernetes: `>=1.14.0-0`
|-----|------|---------|-------------|
| global.platform.cookie | object | `{"encryptionKey":"changeMe00","existingSecret":"","secretKeys":{"encryptionKey":""}}` | Console V2 Cookie Will be deprecated later |
| affinity | object | `{}` | Console affinity |
| annotations | object | `{}` | Console annotations |
| autoscaling.enabled | bool | `false` | |
| autoscaling.maxReplicas | int | `100` | |
| autoscaling.minReplicas | int | `1` | |
Expand Down
4 changes: 4 additions & 0 deletions charts/console/templates/deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ metadata:
namespace: {{ .Release.Namespace }}
labels:
{{- include "core.labels" . | nindent 4 }}
annotations:
{{- with .Values.annotations }}
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
replicas: {{ .Values.replicas }}
selector:
Expand Down
4 changes: 4 additions & 0 deletions charts/console/values.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
"properties": {},
"type": "object"
},
"annotations": {
"properties": {},
"type": "object"
},
"autoscaling": {
"properties": {
"enabled": {
Expand Down
3 changes: 3 additions & 0 deletions charts/console/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,9 @@ ingress:
# -- Console volume mounts
volumeMounts: []

# -- Console annotations
annotations: {}

# -- Console volumes
volumes: []

Expand Down
2 changes: 1 addition & 1 deletion charts/membership/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 1.1.1
version: 1.2.0

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
Expand Down
3 changes: 2 additions & 1 deletion charts/membership/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# membership

![Version: 1.1.1](https://img.shields.io/badge/Version-1.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.36.2](https://img.shields.io/badge/AppVersion-v0.36.2-informational?style=flat-square)
![Version: 1.2.0](https://img.shields.io/badge/Version-1.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.36.2](https://img.shields.io/badge/AppVersion-v0.36.2-informational?style=flat-square)

Formance Membership API. Manage stacks, organizations, regions, invitations, users, roles, and permissions.

Expand Down Expand Up @@ -135,6 +135,7 @@ Kubernetes: `>=1.14.0-0`
| global.nats.enabled | bool | `false` | |
| global.platform.consoleV3.enabled | bool | `false` | |
| affinity | object | `{}` | Membership affinity |
| annotations | object | `{}` | Membership annotations |
| autoscaling | object | `{}` | Membership autoscaling |
| commonLabels | object | `{}` | DEPRECATED Membership service |
| config.additionalEnv | list | `[]` | Additional Environment variables on the main deployment |
Expand Down
4 changes: 4 additions & 0 deletions charts/membership/templates/deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ metadata:
namespace: {{ .Release.Namespace }}
labels:
{{- include "core.labels" . | nindent 4 }}
annotations:
{{- with .Values.annotations }}
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
{{- if not .Values.autoscaling.enabled }}
replicas: {{ .Values.replicaCount }}
Expand Down
4 changes: 4 additions & 0 deletions charts/membership/values.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
"properties": {},
"type": "object"
},
"annotations": {
"properties": {},
"type": "object"
},
"autoscaling": {
"properties": {},
"type": "object"
Expand Down
3 changes: 3 additions & 0 deletions charts/membership/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,9 @@ initContainers: []
# -- Membership volume mounts
volumeMounts: []

# -- Membership annotations
annotations: {}

# -- Membership volumes
volumes: []

Expand Down
2 changes: 1 addition & 1 deletion charts/portal/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 1.1.0
version: 1.2.0

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
Expand Down
3 changes: 2 additions & 1 deletion charts/portal/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# portal

![Version: 1.1.0](https://img.shields.io/badge/Version-1.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 191a441519a65dae56a5b2cf56fe64eee03fc059](https://img.shields.io/badge/AppVersion-191a441519a65dae56a5b2cf56fe64eee03fc059-informational?style=flat-square)
![Version: 1.2.0](https://img.shields.io/badge/Version-1.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 191a441519a65dae56a5b2cf56fe64eee03fc059](https://img.shields.io/badge/AppVersion-191a441519a65dae56a5b2cf56fe64eee03fc059-informational?style=flat-square)

Formance Portal

Expand Down Expand Up @@ -70,6 +70,7 @@ Kubernetes: `>=1.14.0-0`
| global.platform.cookie | object | `{"encryptionKey":"changeMe00","existingSecret":"","secretKeys":{"encryptionKey":""}}` | Console V2 Cookie |
| global.platform.portal.cookie | object | `{"encryptionKey":"changeMe1","existingSecret":"","secretKeys":{"encryptionKey":""}}` | Console V3: EXPERIMENTAL |
| affinity | object | `{}` | Portal affinity |
| annotations | object | `{}` | Portal annotations |
| autoscaling.enabled | bool | `false` | |
| autoscaling.maxReplicas | int | `100` | |
| autoscaling.minReplicas | int | `1` | |
Expand Down
4 changes: 4 additions & 0 deletions charts/portal/templates/deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ metadata:
namespace: {{ .Release.Namespace }}
labels:
{{- include "core.labels" . | nindent 4 }}
annotations:
{{- with .Values.annotations }}
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
replicas: {{ .Values.replicas }}
selector:
Expand Down
4 changes: 4 additions & 0 deletions charts/portal/values.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
"properties": {},
"type": "object"
},
"annotations": {
"properties": {},
"type": "object"
},
"autoscaling": {
"properties": {
"enabled": {
Expand Down
3 changes: 3 additions & 0 deletions charts/portal/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,9 @@ service:
# -- Portal volume mounts
volumeMounts: []

# -- Portal annotations
annotations: {}

# -- Portal volumes
volumes: []

Expand Down
Loading