Skip to content

Next release#1658

Merged
jokob-sk merged 6 commits into
mainfrom
next_release
May 26, 2026
Merged

Next release#1658
jokob-sk merged 6 commits into
mainfrom
next_release

Conversation

@jokob-sk
Copy link
Copy Markdown
Collaborator

@jokob-sk jokob-sk commented May 26, 2026

Summary by CodeRabbit

  • Documentation

    • Reworded English description for sync behavior and updated per-mode recommendations.
    • Updated SYNC_BEHAVIOR references to canonical plugin README URLs.
    • Added a new multi-site monitoring advisory covering hub/node roles, deployment patterns, and best practices.
    • Refined product README intro and MSP/multi-site monitoring content; minor README and docs navigation tweaks.
  • Tests

    • Updated sync endpoint tests to configure plugin log directory via environment/temporary paths instead of previous mocking.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 26, 2026

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: 797ed12a-d45a-4b8d-a6b3-e027fd014cf7

📥 Commits

Reviewing files that changed from the base of the PR and between cc4dd46 and 1094ef3.

📒 Files selected for processing (1)
  • mkdocs.yml
🚧 Files skipped from review as they are similar to previous changes (1)
  • mkdocs.yml

📝 Walkthrough

Walkthrough

Config text for sync behavior is clarified, tests are refactored to use an env-driven plugins log path, a new multi-site monitoring advisory and README tweaks are added, and several docs links plus site navigation entries are canonicalized to the sync plugin README.

Changes

Sync module updates

Layer / File(s) Summary
Sync behavior description update
front/plugins/sync/config.json
The BEHAVIOR setting's en_us description is rephrased to clarify how the hub handles devices from nodes under copy-new, carbon-copy, and hub-defaults with updated recommendation wording.
Test environment setup refactoring
test/api_endpoints/test_sync_endpoint.py
Test module imports are simplified by removing the patch decorator and sync_endpoint import. The two JSON POST tests now accept monkeypatch and tmp_path, create a temporary plugins log directory, and set NETALERTX_PLUGINS_LOG environment variable instead of patching sync_endpoint.INSTALL_PATH.
Documentation link canonicalization
docs/ADVISORY_MULTI_NETWORK.md, docs/API_SYNC.md, docs/REMOTE_NETWORKS.md
Replaced relative SYNC_BEHAVIOR hyperlinks with absolute GitHub README URLs pointing to the sync plugin README (including the sync_behavior anchor where applicable).
Add multi-site monitoring advisory
docs/ADVISORY_MULTI_SITE_MONITORING.md
New advisory added documenting multi-site monitoring architecture, PUSH vs PULL sync modes, device ownership models (copy-new, carbon-copy, hub-defaults), example deployments, recommended MSP features, and related links.
README and plugin README updates, MkDocs nav
README.md, front/plugins/sync/README.md, mkdocs.yml
Condensed README marketing/overview text and added MSP/multi-site sections; minor formatting and heading tweaks in the plugin README; renamed MkDocs nav entries under advanced guides to "Best practice guides" and added the multi-site advisory entry.

Sequence Diagram(s)

(omitted — changes are configuration, documentation, a short config string edit, and a localized test refactor; no new multi-component control flow introduced)

Possibly related PRs

  • netalertx/NetAlertX#1654: Related test and sync endpoint changes touching plugin log handling and sync POST file-write behavior.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 I nibbled at a line of config bright,
I straightened links so docs find home by night,
Tests swapped masks for env-var hats with care,
A new advisory hops into the air,
Tiny tidy hops — the repo breathes a bit more light.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Next release' is vague and generic; it does not describe the specific changes or main focus of the changeset, which includes documentation updates, configuration changes, and test refactoring. Use a more descriptive title that reflects the primary changes, such as 'Update sync documentation and refactor tests for MSP/multi-site monitoring' or similar.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
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 next_release

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
Copy Markdown
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

🤖 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 `@mkdocs.yml`:
- Line 68: Update the nav entry that references the broken filename
`ADVISORY_EYES_ON_GLASSS.md` (triple "S") to the correct
`ADVISORY_EYES_ON_GLASS.md`; locate the nav list containing the "NOC /
Eyes-on-glass dashboard" item and replace the incorrect target string so the
menu points to `ADVISORY_EYES_ON_GLASS.md`.
🪄 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 50f4cb6b-73f3-4a47-be14-9d17af88bd1d

📥 Commits

Reviewing files that changed from the base of the PR and between fccb0b6 and cc4dd46.

📒 Files selected for processing (5)
  • README.md
  • docs/ADVISORY_MULTI_NETWORK.md
  • docs/ADVISORY_MULTI_SITE_MONITORING.md
  • front/plugins/sync/README.md
  • mkdocs.yml
✅ Files skipped from review due to trivial changes (4)
  • front/plugins/sync/README.md
  • docs/ADVISORY_MULTI_NETWORK.md
  • docs/ADVISORY_MULTI_SITE_MONITORING.md
  • README.md

Comment thread mkdocs.yml Outdated
@jokob-sk jokob-sk merged commit 1ede51c into main May 26, 2026
6 checks passed
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