Skip to content

Conversation

@christiangoerdes
Copy link
Collaborator

@christiangoerdes christiangoerdes commented Feb 11, 2026

Summary by CodeRabbit

Release Notes

  • Documentation
    • Added comprehensive migration guide for Membrane 7.1 with new YAML syntax and examples
    • Updated jwtSign configuration: expiryTime renamed to expirySeconds
    • Revised chain and headerFilter configuration patterns with new inline syntax support
    • Noted MethodOverrideInterceptor removal
    • Included before/after YAML examples for configuration migration

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 11, 2026

📝 Walkthrough

Walkthrough

Documentation update for Membrane 7.1 migration guidance, adding new YAML syntax examples, property renames (jwtSign expiryTime to expirySeconds), configuration paradigm changes, and deprecation notes. Pure documentation changes with no code modifications.

Changes

Cohort / File(s) Summary
Migration Guide Documentation
docs/MIGRATION-GUIDE.md
Added Membrane 7.1 migration content including new YAML syntax paradigm, concrete examples for headerFilter, chain configuration, and interceptor updates. Documented jwtSign property rename and MethodOverrideInterceptor removal.

Possibly related PRs

  • Migration guide for 7 #2620: Introduces the main Migration Guide for Membrane 7, which this PR extends with 7.1-specific YAML syntax changes and property renames.

Suggested reviewers

  • rrayst

Poem

🐰 Hops through the docs with glee,
A syntax guide, clear as can be,
New YAML forms, so neat and tight,
Migration made simple and right!

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title 'add migration guide for 7.1' directly and clearly describes the main change: adding documentation for migrating to version 7.1.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch 7.1-migration-guide

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@docs/MIGRATION-GUIDE.md`:
- Around line 269-271: The three incomplete bullets in the migration guide
("Choose Interceptor configuration", "Chain (ChainDef) configuration", and
"OpenApi: rename `specs` to `openapi`") must be expanded or removed: either
convert each into a short subsection mirroring the style of existing entries
(e.g., show "before" and "after" YAML/JSON examples and a brief explanation) —
for "Choose Interceptor configuration" describe the interceptor option names and
example config, for "Chain (ChainDef) configuration" show the old Chain/ChainDef
shape and the new shape with an example, and for "OpenApi: rename `specs` to
`openapi`" provide a concrete before/after snippet and migration note — or
delete these three bullets if they were only planning notes.
🧹 Nitpick comments (1)
docs/MIGRATION-GUIDE.md (1)

267-294: Consider reorganizing this section for clarity.

The content from line 267 onwards lacks the clear structure seen in earlier subsections. Consider organizing it as:

  • Create subsections (###) for each major topic (groovy, YAML list elements, removed interceptors)
  • Group related changes together
  • Ensure each item follows a consistent pattern (description → example/action)

This would match the clear structure of the headerFilter and chain subsections above and make the migration guide easier to follow.

@membrane-ci-server
Copy link

This pull request needs "/ok-to-test" from an authorized committer.

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