You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-7Lines changed: 17 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -6,29 +6,39 @@ This Action wraps the [Sanity CLI](https://github.com/sanity-io/sanity) for usag
6
6
7
7
Prior to `v0.3`, all `args` would be appended to the `sanity` command in entrypoint.sh (meaning one or more `args` was required).
8
8
9
-
As of `v0.3`, entrypoint.sh requires at least two `args`. The first is used to specify the current directory (`.`) or a subdirectory (e.g., `studio`, as with a monorepo). All subsequent `args` are appended to the `sanity`script.
9
+
As of `v0.3`, entrypoint.sh requires at least two `args`. The first is used to specify the current directory (`.`) or a subdirectory (e.g., `studio`, as with a monorepo). All subsequent `args` are appended to the `sanity`command.
10
10
11
-
Example snippet to run `sanity deploy`, where the studio is installed in a `studio` subdirectory:
11
+
### Sample deployment snippet
12
+
13
+
Example snippet to run `sanity deploy`, where the studio is installed in a `studio` subdirectory (see below for full example):
12
14
13
15
```yaml
14
-
# Other workflow commands
16
+
# deploy-sanity-studio.yml
17
+
18
+
# ... other workflow commands ...
15
19
16
20
with:
17
21
args: studio deploy
18
22
```
19
23
20
-
This is not running a command called `studio deploy`. Rather, it is running `cd studio` followed by `sanity deploy`.
24
+
This is _not_ running a command called `studio deploy`. Rather, it is running `cd studio` followed by `sanity deploy`.
25
+
26
+
---
21
27
22
-
Example snippet to run `sanity dataset export production backups/backup.tar.gz`, where the studio is installed at the root of the repository:
28
+
### Sample backup snippet
29
+
30
+
Example snippet to run `sanity dataset export production backups/backup.tar.gz`, where the studio is installed at the root of the repository (see below for full example):
23
31
24
32
```yaml
25
-
# Other workflow commands
33
+
# sanity-backup.yml
34
+
35
+
# ... other workflow commands ...
26
36
27
37
with:
28
38
args: . dataset export production backups/backup.tar.gz
29
39
```
30
40
31
-
This will run `cd .` (staying in the current directory) followed by `sanity dataset export production backups/backup.tar.gz`.
41
+
This will run `cd .` (remaining at the root of the repository) followed by `sanity dataset export production backups/backup.tar.gz`.
0 commit comments