Skip to content

Commit

Permalink
Update "rsconnect content build" sub-command docs in the readme (#602)
Browse files Browse the repository at this point in the history
  • Loading branch information
dbkegley authored Jun 4, 2024
1 parent 4cddae9 commit 3acc215
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -800,15 +800,27 @@ Commands:
```
To build a specific content item, first `add` it to the list of content that is
"tracked" for building using its GUID.
"tracked" for building using its GUID. Content that is "tracked" in the local state
may become out-of-sync with what exists remotely on the Connect server (the result of
`rsconnect content search`). When this happens, it is safe to remove the locally tracked
entries with `rsconnect content build rm`.
> **Note**
> Metadata for "tracked" content items is stored in a local directory called
> `rsconnect-build` which will be automatically created in your current working directory.
> You may set the environment variable `CONNECT_CONTENT_BUILD_DIR` to override this directory location.
```bash
# `add` the content to mark it as "tracked"
rsconnect content build add --guid 4ffc819c-065c-420c-88eb-332db1133317
# run the build which kicks off a cache rebuild on the server
rsconnect content build run
# once the build is complete, the content can be "untracked"
# this does not remove the content from the Connect server
# the entry is only removed from the local state file
rsconnect content build rm --guid 4ffc819c-065c-420c-88eb-332db1133317
```
> **Note**
Expand Down Expand Up @@ -891,6 +903,15 @@ rsconnect content build logs --guid 4ffc819c-065c-420c-88eb-332db1133317
# Task failed. Task exited with status 1.
```
Once a build for a piece of tracked content is complete, it can be safely removed from the list of "tracked"
content by using `rsconnect content build rm` command. This command accepts a `--guid` argument to specify
which piece of content to remove. Removing the content from the list of tracked content simply removes the item
from the local state file, the content deployed to the server remains unchanged.
```bash
rsconnect content build rm --guid 4ffc819c-065c-420c-88eb-332db1133317
```
## Common Usage Examples
### Searching for content
Expand Down

0 comments on commit 3acc215

Please sign in to comment.