docs(ci): document GitHub Action deploy; trigger docs deploy on development
Add a "Deploying from GitHub Actions" section to docs/ci.md covering the smbcloudXYZ/smbcloud-deploy-action composite action. Point deploy-docs.yml at the development branch (the repo's actual deploy branch) instead of the non-functional main filter, so a normal development push deploys the docs site. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
keypair34 committed
Jun 28, 2026 at 13:34 UTC
d8c9c07d05705e343829a15e8d304cde12b5c803
2 files changed
+33
-3
.github/workflows/deploy-docs.yml
+4
-3
@@ -22,8 +22,9 @@ name: Deploy docs
22
# Variables
23
# SMB_DOCS_PROJECT_ID The workspace (project) id
24
#
25
-# Trigger: pushes to main that touch the docs, plus manual runs. Adjust the
26
-# branch to your release flow; workflow_dispatch lets you run it from any branch.
25
+# Trigger: pushes to development (the deploy branch) that touch the docs, plus
26
+# manual runs. Adjust the branch to your release flow; workflow_dispatch lets you
27
+# run it from any branch.
28
#
29
# NOTE: the action installs the latest published CLI release and runs it with
30
# `--ci`. That flag must exist in the installed release, so this requires a
@@ -32,7 +33,7 @@ name: Deploy docs
33
34
on:
35
push:
35
- branches: [main]
36
+ branches: [development]
37
paths:
38
- 'website/**'
39
- 'docs/**'
docs/ci.md
+29
@@ -38,6 +38,35 @@ and write the file at the start of the job:
38
Deploys also rsync over SSH using `~/.ssh/id_<user-id>@smbcloud`; install that
39
key the same way if your project deploys to a server tier.
40
41
+## Deploying from GitHub Actions
42
+
43
+The [`smbcloudXYZ/smbcloud-deploy-action`](https://github.com/smbcloudXYZ/smbcloud-deploy-action)
44
+composite action wraps the steps above: it installs the CLI, writes the token to
45
+the right state dir, optionally installs the SSH key, then runs `smb --ci deploy`.
46
+
47
+```yaml
48
+- uses: smbcloudXYZ/smbcloud-deploy-action@v1
49
+ with:
50
+ token: ${{ secrets.SMB_TOKEN }}
51
+```
52
+
53
+For a monorepo, name the sub-project and pass the SSH inputs that rsync deploys
54
+need:
55
+
56
+```yaml
57
+- uses: smbcloudXYZ/smbcloud-deploy-action@v1
58
+ with:
59
+ token: ${{ secrets.SMB_TOKEN }}
60
+ project: docs
61
+ ssh-private-key: ${{ secrets.SMB_SSH_PRIVATE_KEY }}
62
+ ssh-key-name: ${{ secrets.SMB_SSH_KEY_NAME }}
63
+ ssh-known-hosts: ${{ secrets.SMB_SSH_KNOWN_HOSTS }}
64
+```
65
+
66
+The action installs the latest published CLI release, so `--ci` must exist in
67
+that release. Pin the `version` input if you need a specific CLI version. See the
68
+action's README for the full input reference.
69
+
70
## Example: the AircraftsHub monorepo
71
72
[AircraftsHub](https://aircraftshub.5mb.app) is a Tauri app whose Next.js web app