Skip to content

adds helm changelogs to the docs - #3827

Merged
akshaydeo merged 1 commit into
devfrom
05-28-adds_helm_changelogs_to_the_docs
May 28, 2026
Merged

akshaydeo merged 1 commit into
devfrom
05-28-adds_helm_changelogs_to_the_docs

Conversation

@akshaydeo

@akshaydeo akshaydeo commented May 28, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds Bifrost Helm chart changelogs to the documentation site, covering all releases from v1.7.0 through v2.1.19. This brings the changelog history into the docs navigation so users can track what changed across each Helm chart release.

Changes

  • Added individual changelog pages for every Helm chart release from v1.7.0 through v2.1.19, including the v2.0.0 breaking change (StatefulSet migration for SQLite with persistence), all v2.0.x patch releases, and all v2.1.x releases up to v2.1.19.
  • Registered all new changelog pages in docs.json under a new "Helm" navigation group, organized by month (January–May 2026), with the most recent releases surfaced at the top level outside the monthly groups.

Type of change

  • Bug fix
  • Feature
  • Refactor
  • Documentation
  • Chore/CI

Affected areas

  • Core (Go)
  • Transports (HTTP)
  • Providers/Integrations
  • Plugins
  • UI (React)
  • Docs

How to test

Navigate to the Changelogs section of the docs site and verify the new "Helm" group appears with all releases listed, grouped correctly by month, and that each page renders its changelog content without errors.

Breaking changes

  • Yes
  • No

Related issues

N/A

Security considerations

None.

Checklist

  • I read docs/contributing/README.md and followed the guidelines
  • I added/updated tests where appropriate
  • I updated documentation where needed
  • I verified builds succeed (Go and UI)
  • I verified the CI pipeline passes locally if applicable

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@coderabbitai

coderabbitai Bot commented May 28, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Added comprehensive release changelogs for Helm versions 1.7.0 through 2.1.9, documenting new features, bug fixes, configuration updates, migration guides, and recommended upgrade procedures for platform operators.

Walkthrough

This PR adds 31 comprehensive Helm chart changelog documents spanning versions v1.7.0 through v2.1.19, capturing release notes and migration guidance across major architectural changes, configuration refinements, schema synchronization, and enterprise feature additions. The changelogs are registered in the documentation navigation menu organized by release month.

Changes

Helm Release Changelog Documentation

Layer / File(s) Summary
Early releases and major architectural transitions
docs/changelogs/helm-v1.7.0.mdx, helm-v2.0.0.mdx, helm-v2.0.1.mdx, helm-v2.0.2.mdx, helm-v2.0.5.mdx, helm-v2.0.6.mdx, helm-v2.0.7.mdx, helm-v2.0.8.mdx, helm-v2.0.9.mdx
Documents the foundational shift from Deployment to StatefulSet for SQLite persistence, addition of vector store support (Qdrant, Pinecone), configuration validation parity fixes, and expanded config.schema.json coverage with provider templates and OTEL metrics configuration.
Stabilization and schema maturation
docs/changelogs/helm-v2.0.10.mdx, helm-v2.0.11.mdx, helm-v2.0.12.mdx, helm-v2.0.13.mdx, helm-v2.0.14.mdx, helm-v2.0.15.mdx, helm-v2.0.16.mdx, helm-v2.0.17.mdx
Refines configuration field validation, adds missing plugin properties to match Go implementations, fixes template rendering for MCP clients and health probes, introduces custom plugin placement/ordering, object storage log offloading, and changes behavior to preserve disabled plugins in rendered config output.
Early v2.1 releases and enterprise foundation
docs/changelogs/helm-v2.1.0-prerelease2.mdx, helm-v2.1.1.mdx, helm-v2.1.2.mdx, helm-v2.1.3.mdx, helm-v2.1.4.mdx, helm-v2.1.6.mdx, helm-v2.1.7.mdx, helm-v2.1.8.mdx, helm-v2.1.9.mdx
Establishes schema synchronization between Helm and transport config, makes encryption optional, enforces cluster discovery validation at template render time, adds gRPC cluster communication support, introduces RBAC pod-discovery templates, and adds plugin versioning with PVC label immutability fixes and configuration aliasing.
Recent v2.1 releases and advanced features
docs/changelogs/helm-v2.1.10.mdx, helm-v2.1.11.mdx, helm-v2.1.12.mdx, helm-v2.1.13.mdx, helm-v2.1.14.mdx, helm-v2.1.15.mdx, helm-v2.1.16.mdx, helm-v2.1.17.mdx, helm-v2.1.18.mdx, helm-v2.1.19.mdx
Adds gRPC cluster configuration with port exposure and dial timeout tuning, comprehensive schema/validation updates (description/default fields, stricter additionalProperties), materialized view refresh interval controls for PostgreSQL, flexible Go duration string parsing for timeouts, guardrail max-turns rules, broad SCIM/SSO provider schema extensions, feature flags rendering, and PostgreSQL credential/security context management.
Changelog navigation registry
docs/docs.json
Registers a new top-level "Helm" entry under the main "Changelogs" navigation menu, exposing all 31 Helm changelog pages organized into grouped sections by release month (April 2026, March 2026, February 2026, January 2026).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • danpiths
  • Pratham-Mishra04

🐰 Changelogs bloom like spring clover,
Each release a tale of features new,
From StatefulSets to schemas refined,
The Helm chart journey shines bright and true! ✨
Documentation complete, the future's clear!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: adding Helm changelogs to the documentation.
Description check ✅ Passed The PR description is well-structured, covers all major sections of the template, and clearly documents the changes, testing approach, and confirms no breaking changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 05-28-adds_helm_changelogs_to_the_docs

Comment @coderabbitai help to get the list of available commands and usage tips.

akshaydeo commented May 28, 2026

Copy link
Copy Markdown
Contributor Author

@akshaydeo
akshaydeo marked this pull request as ready for review May 28, 2026 06:10
@greptile-apps

greptile-apps Bot commented May 28, 2026

Copy link
Copy Markdown
Contributor

Confidence Score: 4/5

Safe to merge; all changes are additive documentation with no impact on runtime behaviour.

The changes are purely documentation. The only items worth a second look before merging are the unexplained gap for v2.0.3/v2.0.4 and the inconsistent grouping of May 2026 releases — neither blocks the docs site from rendering correctly.

docs/docs.json — verify the v2.0.3/v2.0.4 gap and the missing May 2026 group label.

Important Files Changed

Filename Overview
docs/docs.json Registers 36 new Helm changelog pages under a new "Helm" navigation group, organized by month. Missing entries for v2.0.3 and v2.0.4 with no explanation, and May 2026 releases are ungrouped while all other months use explicit group labels.
docs/changelogs/helm-v2.0.0.mdx Changelog for the breaking-change v2.0.0 release (StatefulSet migration); includes migration guide. Content is clear and well-structured.
docs/changelogs/helm-v2.1.19.mdx Most-recent changelog (2026-05-26); details feature additions and bug fixes. No issues found.
docs/changelogs/helm-v2.1.6.mdx Changelog for v2.1.6, which explicitly absorbs the unreleased v2.1.5 changes — explains the skipped version in the series.
docs/changelogs/helm-v1.7.0.mdx Oldest changelog entry (v1.7.0); minimal content noting it as the prior stable deployment-based release.

Comments Outside Diff (1)

  1. docs/docs.json, line 766-832 (link)

    P2 Missing v2.0.3 and v2.0.4 changelog entries

    The navigation jumps directly from helm-v2.0.2 to helm-v2.0.5 with no explanation, and there are no corresponding MDX files for v2.0.3 or v2.0.4. By contrast, the skipped v2.1.5 is accounted for in the helm-v2.1.6.mdx file, which explicitly states "Includes unreleased 2.1.5 changes". If v2.0.3 and v2.0.4 were actual Helm chart releases published to the registry, their omission leaves a gap in the changelog history for users upgrading through those versions.

    Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Reviews (1): Last reviewed commit: "adds helm changelogs to the docs" | Re-trigger Greptile

Comment thread docs/docs.json

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/changelogs/helm-v2.0.7.mdx`:
- Line 10: Replace the placeholder line "- Previous release" in the helm v2.0.7
changelog with a concrete release note summarizing key changes for v2.0.7:
mention the main features/fixes (e.g., bug fixes, API changes, performance
improvements or security patches), include concise bullet points or a short
paragraph, and add any relevant upgrade notes or breaking changes under the
v2.0.7 heading so readers understand what changed and if any action is required.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0209fa61-5d34-45fa-aed8-7f35c06e1839

📥 Commits

Reviewing files that changed from the base of the PR and between d50519d and 58769c1.

📒 Files selected for processing (37)
  • docs/changelogs/helm-v1.7.0.mdx
  • docs/changelogs/helm-v2.0.0.mdx
  • docs/changelogs/helm-v2.0.1.mdx
  • docs/changelogs/helm-v2.0.10.mdx
  • docs/changelogs/helm-v2.0.11.mdx
  • docs/changelogs/helm-v2.0.12.mdx
  • docs/changelogs/helm-v2.0.13.mdx
  • docs/changelogs/helm-v2.0.14.mdx
  • docs/changelogs/helm-v2.0.15.mdx
  • docs/changelogs/helm-v2.0.16.mdx
  • docs/changelogs/helm-v2.0.17.mdx
  • docs/changelogs/helm-v2.0.2.mdx
  • docs/changelogs/helm-v2.0.5.mdx
  • docs/changelogs/helm-v2.0.6.mdx
  • docs/changelogs/helm-v2.0.7.mdx
  • docs/changelogs/helm-v2.0.8.mdx
  • docs/changelogs/helm-v2.0.9.mdx
  • docs/changelogs/helm-v2.1.0-prerelease2.mdx
  • docs/changelogs/helm-v2.1.1.mdx
  • docs/changelogs/helm-v2.1.10.mdx
  • docs/changelogs/helm-v2.1.11.mdx
  • docs/changelogs/helm-v2.1.12.mdx
  • docs/changelogs/helm-v2.1.13.mdx
  • docs/changelogs/helm-v2.1.14.mdx
  • docs/changelogs/helm-v2.1.15.mdx
  • docs/changelogs/helm-v2.1.16.mdx
  • docs/changelogs/helm-v2.1.17.mdx
  • docs/changelogs/helm-v2.1.18.mdx
  • docs/changelogs/helm-v2.1.19.mdx
  • docs/changelogs/helm-v2.1.2.mdx
  • docs/changelogs/helm-v2.1.3.mdx
  • docs/changelogs/helm-v2.1.4.mdx
  • docs/changelogs/helm-v2.1.6.mdx
  • docs/changelogs/helm-v2.1.7.mdx
  • docs/changelogs/helm-v2.1.8.mdx
  • docs/changelogs/helm-v2.1.9.mdx
  • docs/docs.json


## Changelog

- Previous release

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Replace placeholder changelog text with a concrete release note.

- Previous release is too vague for a changelog entry and doesn’t communicate what changed in v2.0.7.

Suggested edit
-- Previous release
+- [Add the specific fix/feature shipped in v2.0.7]
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- Previous release
- [Add the specific fix/feature shipped in v2.0.7]
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/changelogs/helm-v2.0.7.mdx` at line 10, Replace the placeholder line "-
Previous release" in the helm v2.0.7 changelog with a concrete release note
summarizing key changes for v2.0.7: mention the main features/fixes (e.g., bug
fixes, API changes, performance improvements or security patches), include
concise bullet points or a short paragraph, and add any relevant upgrade notes
or breaking changes under the v2.0.7 heading so readers understand what changed
and if any action is required.

This was referenced May 28, 2026

akshaydeo commented May 28, 2026

Copy link
Copy Markdown
Contributor Author

Merge activity

  • May 28, 8:48 AM UTC: A user started a stack merge that includes this pull request via Graphite.
  • May 28, 8:49 AM UTC: @akshaydeo merged this pull request with Graphite.

@akshaydeo
akshaydeo merged commit 4dd7eac into dev May 28, 2026
14 of 15 checks passed
@akshaydeo
akshaydeo deleted the 05-28-adds_helm_changelogs_to_the_docs branch May 28, 2026 08:49
akshaydeo added a commit that referenced this pull request May 29, 2026
## Summary

Adds Bifrost Helm chart changelogs to the documentation site, covering all releases from v1.7.0 through v2.1.19. This brings the changelog history into the docs navigation so users can track what changed across each Helm chart release.

## Changes

- Added individual changelog pages for every Helm chart release from v1.7.0 through v2.1.19, including the v2.0.0 breaking change (StatefulSet migration for SQLite with persistence), all v2.0.x patch releases, and all v2.1.x releases up to v2.1.19.
- Registered all new changelog pages in `docs.json` under a new "Helm" navigation group, organized by month (January–May 2026), with the most recent releases surfaced at the top level outside the monthly groups.

## Type of change

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [x] Documentation
- [ ] Chore/CI

## Affected areas

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [x] Docs

## How to test

Navigate to the Changelogs section of the docs site and verify the new "Helm" group appears with all releases listed, grouped correctly by month, and that each page renders its changelog content without errors.

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

N/A

## Security considerations

None.

## Checklist

- [ ] I read `docs/contributing/README.md` and followed the guidelines
- [ ] I added/updated tests where appropriate
- [x] I updated documentation where needed
- [ ] I verified builds succeed (Go and UI)
- [ ] I verified the CI pipeline passes locally if applicable
akhsaul pushed a commit to akhsaul/bifrost that referenced this pull request Aug 27, 2026
## Summary

Adds Bifrost Helm chart changelogs to the documentation site, covering all releases from v1.7.0 through v2.1.19. This brings the changelog history into the docs navigation so users can track what changed across each Helm chart release.

## Changes

- Added individual changelog pages for every Helm chart release from v1.7.0 through v2.1.19, including the v2.0.0 breaking change (StatefulSet migration for SQLite with persistence), all v2.0.x patch releases, and all v2.1.x releases up to v2.1.19.
- Registered all new changelog pages in `docs.json` under a new "Helm" navigation group, organized by month (January–May 2026), with the most recent releases surfaced at the top level outside the monthly groups.

## Type of change

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [x] Documentation
- [ ] Chore/CI

## Affected areas

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [x] Docs

## How to test

Navigate to the Changelogs section of the docs site and verify the new "Helm" group appears with all releases listed, grouped correctly by month, and that each page renders its changelog content without errors.

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

N/A

## Security considerations

None.

## Checklist

- [ ] I read `docs/contributing/README.md` and followed the guidelines
- [ ] I added/updated tests where appropriate
- [x] I updated documentation where needed
- [ ] I verified builds succeed (Go and UI)
- [ ] I verified the CI pipeline passes locally if applicable
occcat pushed a commit to occcat/bifrost that referenced this pull request Sep 2, 2026
## Summary

Adds Bifrost Helm chart changelogs to the documentation site, covering all releases from v1.7.0 through v2.1.19. This brings the changelog history into the docs navigation so users can track what changed across each Helm chart release.

## Changes

- Added individual changelog pages for every Helm chart release from v1.7.0 through v2.1.19, including the v2.0.0 breaking change (StatefulSet migration for SQLite with persistence), all v2.0.x patch releases, and all v2.1.x releases up to v2.1.19.
- Registered all new changelog pages in `docs.json` under a new "Helm" navigation group, organized by month (January–May 2026), with the most recent releases surfaced at the top level outside the monthly groups.

## Type of change

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [x] Documentation
- [ ] Chore/CI

## Affected areas

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [x] Docs

## How to test

Navigate to the Changelogs section of the docs site and verify the new "Helm" group appears with all releases listed, grouped correctly by month, and that each page renders its changelog content without errors.

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

N/A

## Security considerations

None.

## Checklist

- [ ] I read `docs/contributing/README.md` and followed the guidelines
- [ ] I added/updated tests where appropriate
- [x] I updated documentation where needed
- [ ] I verified builds succeed (Go and UI)
- [ ] I verified the CI pipeline passes locally if applicable
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