add migration guide for 7.1#2772
Conversation
📝 WalkthroughWalkthroughDocumentation 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
Possibly related PRs
Suggested reviewers
Poem
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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
headerFilterandchainsubsections above and make the migration guide easier to follow.
|
This pull request needs "/ok-to-test" from an authorized committer. |
Summary by CodeRabbit
Release Notes
expiryTimerenamed toexpirySeconds