ci: stop docs-only PRs hanging on required checks - #34
Merged
Conversation
📝 WalkthroughWalkthroughThe PR updates README.md's "How it works" section by replacing an embedded Mermaid flowchart with a centered HTML ChangesDocumentation: Dark/Light Architecture Diagram
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 6 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (6 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
43-46: ⚡ Quick winAlign alt text with the SVG aria-labels for consistency.
The alt text on the
<img>differs slightly from thearia-labelattributes embedded in both SVG files. Screen reader users may hear different descriptions depending on whether the browser announces thealtor the SVG'saria-label.Current
<img>alt:
- "your server with Syncthing"
- "writes notes into your Obsidian vault"
SVG
aria-label(from both dark/light variants):
- "your server running Syncthing"
- "places notes into your Obsidian vault"
- "silent push wake-ups to the app" (slightly more complete)
♻️ Suggested fix to match the SVG aria-labels
- <img alt="VaultSync architecture: your server with Syncthing syncs peer-to-peer with the VaultSync iOS app, which writes notes into your Obsidian vault. An optional Cloud Relay sends silent push wake-ups." src="docs/images/vaultsync-architecture-light.svg" width="100%"> + <img alt="VaultSync architecture: your server running Syncthing syncs peer-to-peer with the VaultSync iOS app, which places notes into your Obsidian vault. An optional Cloud Relay sends silent push wake-ups to the app." src="docs/images/vaultsync-architecture-light.svg" width="100%">🤖 Prompt for 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. In `@README.md` around lines 43 - 46, Update the <img> alt text so it exactly matches the aria-labels embedded in both SVGs: change the description to "VaultSync architecture: your server running Syncthing syncs peer-to-peer with the VaultSync iOS app, which places notes into your Obsidian vault. An optional Cloud Relay sends silent push wake-ups to the app." Locate the <picture> block and the <img> element and replace the existing alt string to ensure screen readers hear the same text regardless of whether the browser exposes the <img> alt or the SVG aria-label.
🤖 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.
Nitpick comments:
In `@README.md`:
- Around line 43-46: Update the <img> alt text so it exactly matches the
aria-labels embedded in both SVGs: change the description to "VaultSync
architecture: your server running Syncthing syncs peer-to-peer with the
VaultSync iOS app, which places notes into your Obsidian vault. An optional
Cloud Relay sends silent push wake-ups to the app." Locate the <picture> block
and the <img> element and replace the existing alt string to ensure screen
readers hear the same text regardless of whether the browser exposes the <img>
alt or the SVG aria-label.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 7cacdbd5-9950-4209-acc5-2ece3b753f8c
⛔ Files ignored due to path filters (2)
docs/images/vaultsync-architecture-dark.svgis excluded by!**/*.svg,!**/*.svgand included by**/*docs/images/vaultsync-architecture-light.svgis excluded by!**/*.svg,!**/*.svgand included by**/*
📒 Files selected for processing (1)
README.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (2)
**/*
⚙️ CodeRabbit configuration file
**/*: VaultSync syncs private Obsidian notes through Syncthing. Treat data loss,
privacy leaks, security regressions, and broken sync behavior as high priority.
Do not nitpick formatting unless it affects maintainability, correctness, or public API clarity.
Flag any accidental logging, telemetry, crash reporting, or network transfer of note contents,
vault paths, filenames with private context, API keys, APNs tokens, relay keys, or security-scoped bookmark data.
Files:
README.md
**/*.md
⚙️ CodeRabbit configuration file
**/*.md: Review public documentation for technical accuracy, privacy/security claims, App Store-facing wording,
setup correctness, and consistency with the free app plus optional Cloud Relay subscription model.
Files:
README.md
🧠 Learnings (5)
📓 Common learnings
Learnt from: CR
Repo: psimaker/vaultsync
Timestamp: 2026-06-03T13:06:57.552Z
Learning: License all code under MPL-2.0 (Mozilla Public License 2.0)
Learnt from: CR
Repo: psimaker/vaultsync
Timestamp: 2026-06-03T13:06:57.552Z
Learning: Ensure the relay server only sees the Device ID and push token, never notes, file names, folder names, or vault structure
📚 Learning: 2026-05-31T08:18:03.446Z
Learnt from: CR
Repo: psimaker/vaultsync PR: 0
File: docs/architecture.md:0-0
Timestamp: 2026-05-31T08:18:03.446Z
Learning: VaultSync background sync is intentionally asymmetric: Server→iPhone sync is accelerated via Cloud Relay push notifications (server-side file watch + APNs); iPhone→Server sync relies on foreground execution in the VaultSync app, with background refresh as opportunistic only—not guaranteed real-time.
Applied to files:
README.md
📚 Learning: 2026-05-31T08:18:03.446Z
Learnt from: CR
Repo: psimaker/vaultsync PR: 0
File: docs/architecture.md:0-0
Timestamp: 2026-05-31T08:18:03.446Z
Learning: Applies to docs/notify/** : Cloud Relay is an optional Docker sidecar service that watches Syncthing on the homeserver for outgoing changes and sends APNs silent-push wake-ups to the iPhone. Refer to relay-spec.md for protocol details and troubleshooting.md for end-user issues.
Applied to files:
README.md
📚 Learning: 2026-05-31T08:19:08.076Z
Learnt from: CR
Repo: psimaker/vaultsync PR: 0
File: docs/troubleshooting.md:0-0
Timestamp: 2026-05-31T08:19:08.076Z
Learning: Install and open Obsidian at least once on the iOS device before attempting to connect the Obsidian folder in VaultSync
Applied to files:
README.md
📚 Learning: 2026-05-31T08:19:08.076Z
Learnt from: CR
Repo: psimaker/vaultsync PR: 0
File: docs/troubleshooting.md:0-0
Timestamp: 2026-05-31T08:19:08.076Z
Learning: Capture VaultSync version, iOS version, **Sync Issues** screenshot, **Relay Diagnostics** screenshot, and `vaultsync-notify --doctor` output when filing bug reports
Applied to files:
README.md
The required status checks Go Tests and Notify Tests live in ci.yml, which was skipped entirely on docs/markdown-only changes via top-level paths-ignore. Once those jobs became required in branch protection, such PRs hung forever on "Expected — waiting for status" because a path-filtered workflow never reports. Drop paths-ignore so the workflow always runs; the cheap ubuntu required checks now always report green. Gate only the ~10x-priced macOS Build & Test job behind a dorny/paths-filter "code" detector, so docs-only changes still skip the costly build (it is not a required check, so skipping never blocks).
psimaker
changed the title
psimaker
changed the title
psimaker
added a commit
that referenced
this pull request
Jun 3, 2026
The Detect changes job ran dorny/paths-filter without a checkout. On pull_request events that is fine — it lists changed files via the GitHub API. But on push events (the merge of #34 to main) there is no PR to query, so paths-filter falls back to a local git diff and needs a working copy. With no .git present its first git command failed: fatal: not a git repository The process '/usr/bin/git' failed with exit code 128 This surfaced only after merge, since #34 introduced the job itself and push-to-main was the first push event to exercise it. Add actions/checkout as the first step so the job works on both push and pull_request. Co-authored-by: psimaker <psimaker@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
Two related changes — the docs change surfaced a latent CI problem, so both are fixed here.
Docs — architecture diagram
Replace the Mermaid
flowchartin the README with two hand-authored, theme-aware SVGs(
docs/images/vaultsync-architecture-{dark,light}.svg), served via<picture>+prefers-color-scheme. Crisperrendering, proper dark/light variants, and a full
aria-label/altdescription.CI — stop docs-only PRs hanging on required checks
The required status checks Go Tests and Notify Tests live in
ci.yml, which was skipped entirely ondocs/markdown-only changes via a top-level
paths-ignore. Once those jobs became required in branch protection, suchPRs hung forever on "Expected — waiting for status to be reported" (a path-filtered workflow never reports a
status). This PR itself hit that.
Fix:
paths-ignoreso the workflow always triggers; the cheap ubuntu required checks (Go Tests,Notify Tests)now always report green — no reliance on skipped-check semantics.
dorny/paths-filtercodedetector (go/**,ios/**,notify/**,.github/**). Docs-only changes still skip the costly build; it is not a required check, soskipping never blocks a PR.
if:expression (noalways()) keeps the implicit "all needs succeeded" gate, so a failed test job stillskips the build as before.
Notes
Because this branch touches
.github/**, thecodefilter istruefor this PR, so the macOS build runs once hereto validate the CI change itself.