Skip to content

Add "Hot Reload" tutorial and update navigation in "First API" tutorial - #3097

Open
christiangoerdes wants to merge 3 commits into
masterfrom
hot-reload-tutorial
Open

Add "Hot Reload" tutorial and update navigation in "First API" tutorial#3097
christiangoerdes wants to merge 3 commits into
masterfrom
hot-reload-tutorial

Conversation

@christiangoerdes

@christiangoerdes christiangoerdes commented Jul 17, 2026

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Documentation
    • Added a new getting-started tutorial demonstrating hot reload (change upstream target without restarting).
    • Updated the tutorial “Continue” step to point to the new Hot Reload tutorial.
  • Chores
    • Harmonized configuration-change log messaging (consistent capitalization) and lowered one configuration-change notification to debug level.
    • Updated the roadmap with “Log harmonization” guidance and examples.

@christiangoerdes

Copy link
Copy Markdown
Collaborator Author

/ok-to-test

@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 878186b1-6813-4736-945c-3ae66047f760

📥 Commits

Reviewing files that changed from the base of the PR and between 743d876 and cd1dc6d.

📒 Files selected for processing (3)
  • core/src/main/java/com/predic8/membrane/core/router/hotdeploy/YamlHotDeploymentThread.java
  • core/src/main/java/com/predic8/membrane/core/router/hotdeploy/YamlRouterReloader.java
  • docs/ROADMAP.md

📝 Walkthrough

Walkthrough

The getting-started tutorial now includes a hot reload workflow. Configuration reload log messages are adjusted, and the roadmap records log message casing harmonization.

Changes

Hot reload and logging updates

Layer / File(s) Summary
Hot reload tutorial workflow
distribution/tutorials/getting-started/00-First-API.yaml, distribution/tutorials/getting-started/05-Hot-Reload.yaml
The tutorial now references a new hot reload example that configures port 2000, changes the upstream URL, and verifies reloading without a restart.
Configuration reload log harmonization
core/src/main/java/com/predic8/membrane/core/router/hotdeploy/YamlHotDeploymentThread.java, core/src/main/java/com/predic8/membrane/core/router/hotdeploy/YamlRouterReloader.java, docs/ROADMAP.md
Configuration change detection logs at debug level, reload success uses updated capitalization, and the roadmap adds log casing harmonization guidance.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested labels: 7.x

Suggested reviewers: rrayst

Poem

A rabbit hops through YAML bright,
Hot reload changes take their flight.
Logs now whisper, neat and clear,
Fresh config arrives without fear.
Thump, thump—new routes appear!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main changes: adding a Hot Reload tutorial and updating First API navigation.
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.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch hot-reload-tutorial

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.

@membrane-ci-server

Copy link
Copy Markdown

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

@predic8 predic8 self-assigned this Jul 20, 2026
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