Skip to content

docs: 0.1.0 public-docs overhaul + dependency bumps#495

Merged
alexmond merged 1 commit into
mainfrom
docs/0.1.0-prep
Jun 24, 2026
Merged

docs: 0.1.0 public-docs overhaul + dependency bumps#495
alexmond merged 1 commit into
mainfrom
docs/0.1.0-prep

Conversation

@alexmond

Copy link
Copy Markdown
Owner

Prepares jhelm's public-facing docs and dependency versions for the 0.1.0 release. Part of #494.

Docs

  • README — full rewrite: Maven Central / License / Build / codecov / Java badges; "Why jhelm" leading with 346-chart byte-parity with helm template; a modules table; library + Spring Boot starter + REST + CLI surfaces; gotmpl4j called out as the external engine; corrected versions; accurate TemplateAction.render(...) examples. Dropped the "100% Sprig and Helm coverage" overclaim.
  • index / architecture — engine is now the external gotmpl4j (Maven Central), not an in-tree module; added jhelm-rest/jhelm-plugin; CLI 16 → 22 commands.
  • roadmap — gotmpl4j extraction marked done; 300 → 346 charts; fixed the compatibility matrix (Chart Dependencies + Hooks are implemented, were wrongly "pending"; Sprig gaps tracked rather than "100%").
  • nav — grouped the function catalogues under "Template Functions"; removed the two engine-internals pages (template-engine, extending-functions) now owned by gotmpl4j. Kept and corrected core-engine, sprig-functions, function-coverage.
  • changelog.adoc — new; 0.1.0 release notes + Known Limitations (upgrade value-modes, jhelm-gotemplate-helm: backlog from Helm funcs_test.go conformance grind #490 Helm-funcs backlog, subchart coalesce edges — all deferred to 0.2.0 per the 0.1.0 release readiness #494 decision).
  • antora.ymljhelm-version 0.0.1-SNAPSHOT → 0.1.0; fixed stale jhelm-gotemplate* module names across pages.

Dependency bumps

Verified: full build + 499 tests + 346-chart parity all green.

Dependency Was Now
Spring Boot 4.0.6 4.0.7
Kubernetes Client 25.0.0 26.0.0
commons-compress 1.26.1 1.28.0
bouncycastle 1.83 1.84
chicory 1.7.2 1.7.5
swagger-annotations 2.2.34 2.2.52
springdoc-openapi 3.0.2 3.0.3

Note

The README Maven Central and codecov badges will read "not found"/"unknown" until the first 0.1.0 publish populates them — expected, they self-heal on release.

🤖 Generated with Claude Code

Public-facing docs (README, Antora site) and dependency versions prepped for
the 0.1.0 release.

Docs:
- README: badges, modules table, 346-chart byte-parity, library/REST/CLI
  surfaces, gotmpl4j as the external engine; correct versions; accurate
  TemplateAction.render(...) examples. Drop the "100% coverage" overclaim.
- index/architecture: engine is now external gotmpl4j (Maven Central), not an
  in-tree module; add jhelm-rest/jhelm-plugin; CLI 16 -> 22 commands.
- roadmap: mark gotmpl4j extraction done; 300 -> 346 charts; fix the
  compatibility matrix (Chart Dependencies + Hooks are implemented, not pending;
  Sprig gaps tracked rather than "100%").
- nav: group function catalogues; drop the two engine-internals pages
  (template-engine, extending-functions) now owned by gotmpl4j.
- add changelog.adoc (0.1.0 notes + known limitations); antora jhelm-version
  0.0.1-SNAPSHOT -> 0.1.0; fix stale jhelm-gotemplate* module names.

Dependencies (build + 499 tests + 346-chart parity all green):
- Spring Boot 4.0.6 -> 4.0.7 (stay on 4.0.x line)
- Kubernetes Client 25.0.0 -> 26.0.0
- commons-compress 1.26.1 -> 1.28.0, bouncycastle 1.83 -> 1.84,
  chicory 1.7.2 -> 1.7.5, swagger-annotations 2.2.34 -> 2.2.52,
  springdoc-openapi 3.0.2 -> 3.0.3

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U5yvjG89AqMHPAGJawSmg9
@alexmond alexmond added this to the 0.1.0 milestone Jun 24, 2026
@github-actions

Copy link
Copy Markdown
Contributor
Overall Project 81.38% 🍏

There is no coverage information present for the Files changed

@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@alexmond alexmond merged commit b3b6354 into main Jun 24, 2026
1 check passed
@alexmond alexmond deleted the docs/0.1.0-prep branch June 24, 2026 00:30
@github-actions

Copy link
Copy Markdown
Contributor
Overall Project 81.38% 🍏

There is no coverage information present for the Files changed

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.

2 participants