Skip to content

chore: replace bitnami readme-generator with helm-docs#113

Merged
alambare merged 1 commit into
mainfrom
chore/migrate-helm-docs
May 11, 2026
Merged

chore: replace bitnami readme-generator with helm-docs#113
alambare merged 1 commit into
mainfrom
chore/migrate-helm-docs

Conversation

@alambare
Copy link
Copy Markdown
Collaborator

  • Convert all ## @param/@section annotations in values.yaml to helm-docs inline # -- format
  • Add README.md.gotmpl to preserve static sections (TL;DR, Prerequisites, install/uninstall, configuration details, license)
  • Add helm-docs-container pre-commit hook (runs via Docker, no local install needed, enforced in CI via tox linters env)
  • Add 'make helm-docs' target for manual regeneration
  • Remove package.json (no more npm dependency)

@alambare alambare force-pushed the chore/migrate-helm-docs branch from 0f71c49 to 2cb9977 Compare May 11, 2026 11:25
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 11, 2026

badge

Code Coverage

Details
Filename                                 Stmts    Miss  Cover    Missing
-------------------------------------  -------  ------  -------  ------------------------------------------------------------------------------------------------------------------------
eodag/__init__.py                            0       0  100.00%
eodag/app.py                                73      15  79.45%   122, 136-143, 154-156, 212-224, 228
eodag/client.py                             25       0  100.00%
eodag/config.py                             19       0  100.00%
eodag/constants.py                           5       0  100.00%
eodag/core.py                              316      27  91.46%   136-137, 147, 293-294, 384, 518-519, 538, 569, 655, 671-675, 689-693, 695-699, 704, 717, 727-729, 732-733, 743, 746, 762
eodag/cql_evaluate.py                       48      18  62.50%   48, 53, 58, 75, 78, 81, 86-99, 105
eodag/dag.py                                57       0  100.00%
eodag/errors.py                             94       7  92.55%   145, 162-165, 181, 205
eodag/logs.py                               62       9  85.48%   40-49, 105
eodag/middlewares.py                        32       2  93.75%   20, 24
eodag/telemetry.py                          44       0  100.00%
eodag/utils.py                              41      10  75.61%   44, 69, 72-73, 86, 90-98, 134
eodag/eodag_types/__init__.py                0       0  100.00%
eodag/eodag_types/queryables.py             42       8  80.95%   46, 50-51, 61, 77-81
eodag/eodag_types/search.py                 25      25  0.00%    20-69
eodag/extensions/collection_order.py        73       1  98.63%   106
eodag/extensions/data_download.py          121      42  65.29%   61-73, 94, 112-113, 120, 135-142, 147-148, 155-187, 195-198
eodag/extensions/filter.py                 106      10  90.57%   185-186, 228, 286-287, 307, 315, 321, 339-341
eodag/extensions/offset_pagination.py       12       0  100.00%
eodag/models/__init__.py                     0       0  100.00%
eodag/models/item.py                        82       6  92.68%   49-52, 54, 67
eodag/models/links.py                      148      13  91.22%   39, 93-95, 201, 219, 251, 299, 348-359
eodag/models/stac_metadata.py                5       0  100.00%
TOTAL                                     1430     193  86.50%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  --------
TOTAL             0       0  +100.00%

Results for commit: d4130a6

Minimum allowed coverage is 70%

♻️ This comment has been updated with latest results

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 11, 2026

Test Results

  4 files  ±0    4 suites  ±0   1m 38s ⏱️ +4s
113 tests ±0  113 ✅ ±0  0 💤 ±0  0 ❌ ±0 
452 runs  ±0  452 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 1d3e548. ± Comparison against base commit b465f43.

♻️ This comment has been updated with latest results.

@alambare alambare force-pushed the chore/migrate-helm-docs branch from 2cb9977 to 1d3e548 Compare May 11, 2026 11:29
- Convert all ## @param/@section annotations in values.yaml to
  helm-docs inline # -- format
- Add README.md.gotmpl to preserve static sections (TL;DR,
  Prerequisites, install/uninstall, configuration details, license)
- Add helm-docs-container pre-commit hook (runs via Docker, no
  local install needed, enforced in CI via tox linters env)
- Add 'make helm-docs' target for manual regeneration
- Remove package.json (no more npm dependency)
@alambare alambare force-pushed the chore/migrate-helm-docs branch from 1d3e548 to d4130a6 Compare May 11, 2026 11:31
@alambare alambare merged commit a06e930 into main May 11, 2026
8 checks passed
@alambare alambare deleted the chore/migrate-helm-docs branch May 11, 2026 11:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant