Skip to content

Commit 54437cc

Browse files
committed
docs(readme): add cloud backup via Rclone workflow
When: 2025-08-31T00:45:00Z Why: The template includes a GitHub Actions backup workflow calling a shared cloud-sync workflow and Setup Rclone Action. This is a free alternative to paid backup tools. It’s safe by default and requires an RCLONE_CONFIG repo secret to run. What changed: - README.md: added “☁️ GitHub Actions cloud sync backup (Rclone)” subsection with links, safety notes, secret requirement, and opt-out. Also added the item to the top “What’s in the box” list. - .stan/system/stan.todo.md: recorded the docs update and added next steps (set RCLONE_CONFIG or remove sync.yml).
1 parent 3be1bcb commit 54437cc

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

.stan/system/stan.todo.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
When updated: 2025-08-31T00:28:00Z
1+
When updated: 2025-08-31T00:45:00Z
22

33
Next up
44

@@ -8,9 +8,13 @@ Next up
88
- Re-run: npm run lint to confirm the Windows tseslint parser fix.
99
- Normalize line endings to LF if you see CRLF noise: • git add --renormalize . • npm run lint:fix • commit the normalization
1010
- Verify lint includes /playground and excludes only generated output.
11+
- To enable cloud backups, set the RCLONE_CONFIG repo secret (see Setup Rclone Action). If you don’t want backups, delete .github/workflows/sync.yml.
1112

1213
Completed (recent)
1314

15+
- README: documented GitHub Actions cloud sync backup via Rclone; added safety/secret/opt‑out notes and links.
16+
- README: added STAN to “What’s in the box” and a new “In The Box” section with emoji-rich, linked subsections; updated Contents.
17+
- Lint: sorted imports and ensured EOF newline in eslint.config.ts to satisfy simple-import-sort and Prettier.
1418
- Deduped ESLint config: shared Prettier/import-sort for JS/TS; kept TS-specific rules; expanded Vitest test globs to include JS.
1519
- Fixed ESLint parser error on Windows by setting parserOptions.tsconfigRootDir = path.resolve() in eslint.config.ts.
1620
- Clarified lint/format policy: include /playground; exclude generated outputs; rely on editor Prettier (no new Lefthook script).

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ What's in the box:
2020
- 📚 TypeDoc for API documentation
2121
- 🚀 release‑it for releases (optional Lefthook Git hooks)
2222
- 🤖 STAN — AI‑assisted refactoring & patch workflow
23+
- ☁️ GitHub Actions cloud sync backup (Rclone)
2324
- 🧩 Peer dependencies: react, react‑dom (>=18); sideEffects: false
2425

2526
Contents
@@ -97,10 +98,18 @@ Delightful defaults with modern tooling — batteries included, no drama.
9798
- STAN: https://github.com/karmaniverous/stan
9899
- A rigorous, patch‑first assistant that helps refactor safely, keep docs in sync, and maintain clean diffs
99100

101+
### ☁️ GitHub Actions cloud sync backup (Rclone)
102+
103+
- Workflow: this repo ships a backup workflow at `.github/workflows/sync.yml` which calls a shared workflow: https://github.com/karmaniverous/gha-workflows/blob/main/.github/workflows/cloud-sync.yml
104+
- It leverages the Setup Rclone Action: https://github.com/marketplace/actions/setup-rclone-action
105+
- Free and useful: a simple, no‑cost alternative to pricey GitHub backup tools.
106+
- Safe by default: a clone from this template will NOT back up to anyone’s cloud without credentials. The action will FAIL unless the `RCLONE_CONFIG` repo secret is set (providing auth + destination).
107+
- Don’t want it? Just delete `.github/workflows/sync.yml`.
108+
- See the action page for details on configuring `RCLONE_CONFIG`.
109+
100110
### 🧩 Peer dependencies & tree‑shaking
101111

102-
- peerDependencies (npm): https://docs.npmjs.com/files/package.json/
103-
- `sideEffects: false` (tree‑shaking hint): https://webpack.js.org/guides/tree-shaking/
112+
- peerDependencies (npm): https://docs.npmjs.com/files/package.json/- `sideEffects: false` (tree‑shaking hint): https://webpack.js.org/guides/tree-shaking/
104113

105114
---
106115

0 commit comments

Comments
 (0)