Skip to content

Native iCloud apps for Windows and Linux, built in Rust. Notes, Reminders, Calendar, Contacts, Drive and Photos, offline and in sync with your iPhone.

Publish only what is meant to be public: a path allowlist and a secret scan in CI, the gate and the release

Yashwanth Kamireddi689130efa7d0
diff --git a/.github/published-paths b/.github/published-paths
new file mode 100644
index 0000000..4f9cf23
--- /dev/null
+++ b/.github/published-paths
@@ -0,0 +1,20 @@
+# Every file this repository publishes, as extended regular expressions (whole path). A tracked
+# file matching none of these fails CI, the local gate (check.sh) and the release: a broad
+# `git add` once published another app's installer (install-arch.sh) and every local note in
+# docs/. Add a line here only for something meant to be public.
+\.github/.*
+\.copr/.*
+\.uiverify/.*\.(mjs|py|sh|webm)
+probe/(Cargo\.toml|src/.*|examples/.*\.rs)
+src/.*
+src-tauri/.*
+crates/.*
+packaging/.*
+snap/.*
+docs/media/.*
+(\.gitignore|\.gitleaks\.toml|\.gitleaksignore)
+(ARCHITECTURE|README|SECURITY|PRIVACY)\.md
+LICENSE
+(Cargo\.toml|Cargo\.lock|rust-toolchain\.toml)
+(package\.json|package-lock\.json|tsconfig\.json|vite\.config\.ts|index\.html)
+(check\.sh|run\.sh)
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 5b35057..226235f 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -31,6 +31,33 @@ env:
CARGO_PROFILE_TEST_DEBUG: "0"
jobs:
+ # What the repository publishes: only paths .github/published-paths names (a broad `git add`
+ # once published another app's installer and every local note), and no secret in any commit.
+ published:
+ runs-on: ubuntu-24.04
+ timeout-minutes: 5
+ steps:
+ - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+ with:
+ fetch-depth: 0
+ - name: Nothing stray is tracked
+ run: |
+ stray=$(git ls-files | grep -vxE -f <(grep -vE '^(#|$)' .github/published-paths) || true)
+ if [ -n "$stray" ]; then
+ echo "::error::Tracked but not meant to be published (add to .github/published-paths only if it is):"
+ echo "$stray"
+ exit 1
+ fi
+ - name: No secret in any commit
+ env:
+ GITLEAKS: "8.30.1"
+ run: |
+ curl -fsSL -o gl.tgz "https://github.com/gitleaks/gitleaks/releases/download/v${GITLEAKS}/gitleaks_${GITLEAKS}_linux_x64.tar.gz"
+ curl -fsSL "https://github.com/gitleaks/gitleaks/releases/download/v${GITLEAKS}/gitleaks_${GITLEAKS}_checksums.txt" \
+ | grep " gitleaks_${GITLEAKS}_linux_x64.tar.gz$" | sed 's/ .*/ gl.tgz/' | sha256sum -c -
+ tar -xzf gl.tgz gitleaks
+ ./gitleaks git --no-banner --redact .
+
rust:
runs-on: ubuntu-24.04
timeout-minutes: 50 # a cold cache (new toolchain, new lockfile) compiles everything; warm runs take ~12
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index f5e5983..bdc5334 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -205,6 +205,12 @@ jobs:
with:
fetch-depth: 1
path: source
+ # A tag publishes only what is meant to be public (see ci.yml's `published`).
+ - name: Nothing stray is published
+ working-directory: source
+ run: |
+ stray=$(git ls-files | grep -vxE -f <(grep -vE '^(#|$)' .github/published-paths) || true)
+ if [ -n "$stray" ]; then echo "::error::Not meant to be published:"; echo "$stray"; exit 1; fi
- uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
with:
path: dist
diff --git a/.gitleaksignore b/.gitleaksignore
index 6de9b48..97c0835 100644
--- a/.gitleaksignore
+++ b/.gitleaksignore
@@ -2,3 +2,6 @@
7b3fa60cf2d29c017c05998f560c22251ef95d26:crates/quince-auth/testdata/srp_vectors.json:generic-api-key:10
7b3fa60cf2d29c017c05998f560c22251ef95d26:crates/quince-auth/testdata/srp_vectors.json:generic-api-key:17
7b3fa60cf2d29c017c05998f560c22251ef95d26:crates/quince-auth/testdata/srp_vectors.json:generic-api-key:25
+# A made-up journal key in a UI check (32 hex digits standing for a download's id) — not a secret.
+4f68cebf8026cc9a01f7cc6861b73dbcf4231b29:.uiverify/drive-download.mjs:generic-api-key:177
+39313cf5ee236cdaa6972b2a95afe5cc2818a7d7:.uiverify/drive-download.mjs:generic-api-key:177
diff --git a/check.sh b/check.sh
index af27ad9..bf12cf0 100755
--- a/check.sh
+++ b/check.sh
@@ -15,6 +15,9 @@ step() {
# dev` being up and healthy, which produced both a connection error and a blank window.
step "app is standalone" bash -c '! grep -q devUrl src-tauri/tauri.conf.json'
+# Only what is meant to be public is tracked (.github/published-paths says what that is).
+step "nothing stray is published" bash -c '! git ls-files | grep -vxE -f <(grep -vE "^(#|$)" .github/published-paths)'
+
step "rust format" cargo fmt --all -- --check
step "rust lint" cargo clippy --workspace --all-targets -- -D warnings
step "rust tests" cargo test --workspace --quiet