Skip to content

Commit 3acc215

Browse files
authored
Update "rsconnect content build" sub-command docs in the readme (#602)
1 parent 4cddae9 commit 3acc215

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

+22-1
Original file line numberDiff line numberDiff line change
@@ -800,15 +800,27 @@ Commands:
800800
```
801801
802802
To build a specific content item, first `add` it to the list of content that is
803-
"tracked" for building using its GUID.
803+
"tracked" for building using its GUID. Content that is "tracked" in the local state
804+
may become out-of-sync with what exists remotely on the Connect server (the result of
805+
`rsconnect content search`). When this happens, it is safe to remove the locally tracked
806+
entries with `rsconnect content build rm`.
804807
805808
> **Note**
806809
> Metadata for "tracked" content items is stored in a local directory called
807810
> `rsconnect-build` which will be automatically created in your current working directory.
808811
> You may set the environment variable `CONNECT_CONTENT_BUILD_DIR` to override this directory location.
809812
810813
```bash
814+
# `add` the content to mark it as "tracked"
811815
rsconnect content build add --guid 4ffc819c-065c-420c-88eb-332db1133317
816+
817+
# run the build which kicks off a cache rebuild on the server
818+
rsconnect content build run
819+
820+
# once the build is complete, the content can be "untracked"
821+
# this does not remove the content from the Connect server
822+
# the entry is only removed from the local state file
823+
rsconnect content build rm --guid 4ffc819c-065c-420c-88eb-332db1133317
812824
```
813825
814826
> **Note**
@@ -891,6 +903,15 @@ rsconnect content build logs --guid 4ffc819c-065c-420c-88eb-332db1133317
891903
# Task failed. Task exited with status 1.
892904
```
893905
906+
Once a build for a piece of tracked content is complete, it can be safely removed from the list of "tracked"
907+
content by using `rsconnect content build rm` command. This command accepts a `--guid` argument to specify
908+
which piece of content to remove. Removing the content from the list of tracked content simply removes the item
909+
from the local state file, the content deployed to the server remains unchanged.
910+
911+
```bash
912+
rsconnect content build rm --guid 4ffc819c-065c-420c-88eb-332db1133317
913+
```
914+
894915
## Common Usage Examples
895916
896917
### Searching for content

0 commit comments

Comments
 (0)