Skip to content

docs: spell out the 1.0.0 breaking changes and upgrade notes in the changelog [ENG-1742] - #65

Merged
twk3 merged 1 commit into
mainfrom
docs/currents-1.0.0-changelog
Oct 14, 2026
Merged

twk3 merged 1 commit into
mainfrom
docs/currents-1.0.0-changelog

Conversation

@twk3

@twk3 twk3 commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Rewrites the currents-1.0.0 CHANGELOG entry before the chart is published (ENG-1742).

scripts/update-changelog.sh (git-cliff) listed only the two feat: commits, under Features. 1.0.0 is a major release because SAML SSO breaks, and operators look for that in a major release's changelog. The entry now stands on its own:

  • Intro:
    • the images (2026-10-14-001);
    • that this is the chart's first major version;
    • that SSO breaks until the IdP is updated;
    • a link to docs/eks/upgrade-1.0.md;
    • semantic versioning from 1.0.0.
  • Breaking Changes:
    • the SAML ACS URL move, with the IdP steps: ACS URL, Recipient and Destination, and the Audience left as it is;
    • IdP-initiated sign-ins now need currents.sso.saml.allowIdpInitiated;
    • the removed currents.sso.saml.spCertKey.
  • Upgrade Notes:
    • create the app content bucket first;
    • the startup migrations: timings, not downtime, Startup tasks complete, restart on error;
    • back up first, because helm rollback doesn't undo the migrations.
  • Added:
    • appContentStorage.*, mcp.*, oauth.* and sso.saml.allowIdpInitiated;
    • what the images add, with a link to the Docker Compose changelog for 2026-10-14-001.
  • Changed:
    • MCP and OAuth are on after the upgrade, and how to keep them off;
    • the dependency guidance, including the bundled Redis and draining its queues;
    • where the 0.8.x docs stay published.
  • Commits: the generated list, unchanged.

A later update-changelog.sh run prepends the next version's entry and leaves this one as it is. Every relative link points at a heading that exists on main.

After merge

Run the Release Charts workflow to publish 1.0.0, then complete the Linear release currents-1.0.0.

🤖 Generated with Claude Code

https://claude.ai/code/session_01UhM4wHR2xPP8bbrkXGaqUD


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need.

…hangelog [ENG-1742]

git-cliff listed only the two feat commits under the 1.0.0 entry. A
major release is where operators look for what breaks, so the entry now
has Breaking Changes (the SAML ACS URL, IdP-initiated sign-ins, the
removed spCertKey), Upgrade Notes (the app content bucket, the startup
migrations, backups), Added (the new values), and Changed (MCP and OAuth
on by default, the dependency guidance, where the 0.8 docs live). The
generated commit list stays, under Commits.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UhM4wHR2xPP8bbrkXGaqUD
@baz-reviewer

baz-reviewer Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Review this PR on Baz

Baz Summary

Clarify the currents-1.0.0 changelog to document the chart’s first major release, its SAML SSO breaking changes, upgrade requirements, migration behavior, and semantic-versioning policy. Highlight new MCP, OAuth, app-content storage, and SAML settings, plus dependency guidance and release image details for operators.

Topics

TopicDetails
Release Guidance Describe newly available app-content storage, MCP, OAuth, and SAML settings, clarify their post-upgrade defaults and dependency recommendations, and link the relevant release and versioning documentation.
Modified files (1)
  • CHANGELOG.md
Latest Contributors(1)
UserCommitDate
dj@currents.devdocs: spell out the 1....October 14, 2026
Breaking Changes Document the SAML ACS URL migration, IdP-initiated sign-in setting, removed spCertKey, required bucket setup, migration timing and rollback limitations so operators can safely upgrade to chart 1.0.
Modified files (1)
  • CHANGELOG.md
Latest Contributors(1)
UserCommitDate
dj@currents.devdocs: spell out the 1....October 14, 2026

Merger  Activate to get a short verdict whether this PR is good to go or not

Skills  Activate Skill Maintainer to keep your skills up to date

Planner  This PR would have been improved with Baz Planner - Try it now

@twk3
twk3 marked this pull request as ready for review October 14, 2026 23:32
@twk3
twk3 merged commit 8411829 into main Oct 14, 2026
3 checks passed
@twk3
twk3 deleted the docs/currents-1.0.0-changelog branch October 14, 2026 23:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant