Skip to content

Commit

Permalink
📝(project) add a specific CHANGELOG.md for the helm chart
Browse files Browse the repository at this point in the history
Changes on Ralph Helm chart are decorrelated from Ralph changes.
Creating a separated helm chart CHANGELOG to keep track of these changes.
  • Loading branch information
wilbrdt committed Nov 14, 2023
1 parent cb8371d commit 08443f6
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 15 deletions.
15 changes: 0 additions & 15 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ and this project adheres to
- Implement Pydantic model for LRS Statements resource query parameters
- Implement xAPI LMS Profile statements validation
- `EdX` to `xAPI` converters for enrollment events
- Helm: Add variable ``ingress.hosts``
- Backends: Add `Writable` and `Listable` interfaces to distinguish supported
functionalities among `data` backends
- Backends: Add `get_backends` function to automatically discover backends
Expand All @@ -27,7 +26,6 @@ interface [BC]
- Refactor LRS `query_statements` and `query_statements_by_ids` backends
methods under the unified `lrs` backend interface [BC]
- Refactor LRS Statements resource query parameters defined for `ralph` API
- Helm chart: improve chart modularity
- User credentials must now include an "agent" field which can be created
using the cli
- `GET /statements` now has "mine" option which matches statements that
Expand All @@ -51,8 +49,6 @@ have an authority field matching that of the user
- API: Add `RALPH_LRS_RESTRICT_BY_AUTHORITY` option making `?mine=True`
implicit
- CLI: list cli usage strings in alphabetical order
- Helm: Fix clickhouse version
- Helm: improve volumes and ingress configurations
- API: Add `RALPH_LRS_RESTRICT_BY_SCOPE` option enabling endpoint access
control by user scopes
- Backends: Replace reference to a JSON column in ClickHouse with
Expand All @@ -68,7 +64,6 @@ have an authority field matching that of the user

- `school`, `course`, `module` context extensions in Edx to xAPI base converter
- `name` field in `VideoActivity` xAPI model mistakenly used in `video` profile
- Helm: remove variable ``ingress.hostname`` and ``ingress.tls``

## [3.9.0] - 2023-07-21

Expand All @@ -80,15 +75,6 @@ have an authority field matching that of the user
- Enforce valid IRI for `activity` parameter in `GET /statements`
- Change how duplicate xAPI statements are handled for `clickhouse` backend

General improvement for the Helm Chart:

- add dependencies for MongoDB and Clickhouse
- make persistence optional
- allow use existing PVC
- remove prefix label from ingress object name
- add missing namespace label
- make object name consistent

## [3.8.0] - 2023-06-21

### Added
Expand Down Expand Up @@ -206,7 +192,6 @@ as per the xAPI specification
### Added

- Add a new `auth` subcommand to generate required credentials file for the LRS
- Add an official Helm Chart (experimental)
- Implement support for AWS S3 storage backend
- Add CLI `--version` option

Expand Down
36 changes: 36 additions & 0 deletions src/helm/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Changelog

All notable changes to the helm chart will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).


## [Unreleased]

## [0.2.0] - 2023-11-08

### Added

- Add variable ``ingress.hosts``

### Changed

- Improve chart modularity
- Fix clickhouse version
- Improve volumes and ingress configurations

### Removed

- Remove variable ``ingress.hostname`` and ``ingress.tls``

## [0.1.0] - 2023-06-30

### Added

- Add an official Helm Chart (experimental)

[unreleased]: https://github.com/openfun/ralph/tree/master/src/helm
[0.2.0]: https://github.com/openfun/ralph/releases/tag/helm-v0.2.0
[0.1.0]: https://github.com/openfun/ralph/releases/tag/helm-v0.1.0

0 comments on commit 08443f6

Please sign in to comment.