Skip to content

Commit 83844b4

Browse files
committed
Clarify README
1 parent ab4cb19 commit 83844b4

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,39 @@ This Action wraps the [Sanity CLI](https://github.com/sanity-io/sanity) for usag
66

77
Prior to `v0.3`, all `args` would be appended to the `sanity` command in entrypoint.sh (meaning one or more `args` was required).
88

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.
1010

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):
1214

1315
```yaml
14-
# Other workflow commands
16+
# deploy-sanity-studio.yml
17+
18+
# ... other workflow commands ...
1519

1620
with:
1721
args: studio deploy
1822
```
1923
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+
---
2127

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):
2331

2432
```yaml
25-
# Other workflow commands
33+
# sanity-backup.yml
34+
35+
# ... other workflow commands ...
2636
2737
with:
2838
args: . dataset export production backups/backup.tar.gz
2939
```
3040

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`.
3242

3343
## Usage
3444

0 commit comments

Comments
 (0)