Skip to content

publishCommunity

publishCommunity(options): Promise<CommunityPublishResponse>

Defined in: publishCommunity.ts:59

Trigger a community publish via the Connect REST API and poll until the job reaches a terminal state, throwing if it fails.

Shared by simply community publish and simply community url set --publish so the Connect API call and the poll for completion exist in exactly one place.

PublishCommunityOptions

The connection, the Network.Id to publish, and wait/retry settings.

Promise<CommunityPublishResponse>

The Connect API’s publish response: id, jobId, name, and url.

CommunityPublishFailedError if the job reaches a terminal failure state.

If the initial publish request fails and retries (if any) are exhausted.