Skip to content

Commit 32acf65

Browse files
committed
tidy docs
1 parent dc6df88 commit 32acf65

3 files changed

Lines changed: 10 additions & 20 deletions

File tree

docs/CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1515
When neither `-n/--name` nor `-s/--server` is provided, the default server is
1616
used automatically. `rsconnect login` sets the server as default unless
1717
`--no-set-default` is passed. `CONNECT_SERVER` still takes precedence.
18+
- Added `rsconnect deploy git` command to create a [git-backed deployment](https://docs.posit.co/connect/user/git-backed/).
19+
Use `--branch` to specify a branch (default: main) and `--subdirectory` to deploy content from a subdirectory.
1820

1921
## [1.29.0] - 2026-04-29
2022

@@ -25,8 +27,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2527

2628
### Added
2729

28-
- Added `rsconnect deploy git` command to create a [git-backed deployment](https://docs.posit.co/connect/user/git-backed/).
29-
Use `--branch` to specify a branch (default: main) and `--subdirectory` to deploy content from a subdirectory.
3030
- `rsconnect content get-lockfile` command allows fetching a lockfile with the
3131
dependencies installed by connect to run the deployed content
3232
- `rsconnect content venv` command recreates a local python environment

rsconnect/api.py

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -725,8 +725,6 @@ def content_deploy(
725725
def get_repository(self, content_guid: str) -> Optional[RepositoryInfo]:
726726
"""Get git repository configuration for a content item.
727727
728-
GET /v1/content/{guid}/repository
729-
730728
:param content_guid: The GUID of the content item
731729
:return: Repository configuration if git-managed, None otherwise
732730
"""
@@ -748,13 +746,11 @@ def set_repository(
748746
) -> RepositoryInfo:
749747
"""Create or overwrite git repository configuration for a content item.
750748
751-
PUT /v1/content/{guid}/repository
752-
753749
:param content_guid: The GUID of the content item
754750
:param repository: URL of the git repository (https:// only)
755751
:param branch: Branch to deploy from (default: main)
756752
:param directory: Directory containing manifest.json (default: .)
757-
:param polling: Enable auto-redeploy when commits are pushed (default: True)
753+
:param polling: Whether the git repository should be regularly polled (default: True)
758754
:return: The repository configuration
759755
"""
760756
body = {
@@ -780,15 +776,13 @@ def update_repository(
780776
) -> RepositoryInfo:
781777
"""Partially update git repository configuration for a content item.
782778
783-
PATCH /v1/content/{guid}/repository
784-
785779
Only fields that are provided will be updated.
786780
787781
:param content_guid: The GUID of the content item
788782
:param repository: URL of the git repository (https:// only)
789783
:param branch: Branch to deploy from
790784
:param directory: Directory containing manifest.json
791-
:param polling: Enable auto-redeploy when commits are pushed
785+
:param polling: Whether the git repository should be regularly polled
792786
:return: The updated repository configuration
793787
"""
794788
body: dict[str, str | bool] = {}
@@ -811,8 +805,6 @@ def update_repository(
811805
def delete_repository(self, content_guid: str) -> None:
812806
"""Remove git repository configuration from a content item.
813807
814-
DELETE /v1/content/{guid}/repository
815-
816808
:param content_guid: The GUID of the content item
817809
"""
818810
response = self.delete("v1/content/%s/repository" % content_guid)
@@ -828,8 +820,6 @@ def create_bundle_from_repository(
828820
) -> RepositoryBundleOutput:
829821
"""Create a bundle from a git repository location.
830822
831-
POST /v1/content/{guid}/repository/bundle
832-
833823
This triggers Connect to clone the repository and create a bundle.
834824
If the content item has existing git configuration, those values are used
835825
as defaults; provided parameters will override them.
@@ -870,7 +860,7 @@ def deploy_git(
870860
"""Deploy content from a git repository.
871861
872862
Creates or updates a git-backed content item in Posit Connect. Connect will clone
873-
the repository and automatically redeploy when commits are pushed (if polling is enabled).
863+
the repository and regularly poll it for updates.
874864
875865
:param app_id: Existing content ID/GUID to update, or None to create new content
876866
:param name: Name for the content item (used if creating new)
@@ -879,7 +869,7 @@ def deploy_git(
879869
:param subdirectory: Subdirectory containing manifest.json
880870
:param title: Title for the content
881871
:param env_vars: Environment variables to set
882-
:param polling: Enable auto-redeploy when commits are pushed (default: True)
872+
:param polling: Whether the git repository should be regularly polled (default: True)
883873
:param activate: Whether to activate the deployment (False = draft mode)
884874
:return: Deployment result with task_id, app info, etc.
885875
"""
@@ -1565,7 +1555,7 @@ def deploy_git(self, activate: bool = True):
15651555
"""Deploy content from a remote git repository.
15661556
15671557
Creates a git-backed content item in Posit Connect. Connect will clone
1568-
the repository and automatically redeploy when commits are pushed.
1558+
the repository and regularly poll it for updates.
15691559
"""
15701560
if not isinstance(self.client, RSConnectClient):
15711561
raise RSConnectException(

rsconnect/main.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1731,7 +1731,7 @@ def deploy_manifest(
17311731
help=(
17321732
"Deploy content to Posit Connect directly from a remote Git repository. "
17331733
"The repository must contain a manifest.json file (in the root or specified subdirectory). "
1734-
"Connect will periodically check for updates and redeploy automatically when commits are pushed."
1734+
"Connect will regularly poll the repository for updates."
17351735
"\n\n"
17361736
"This command creates a new git-backed content item. To update an existing git-backed "
17371737
"content item, use the --app-id option with the content's GUID."
@@ -1750,7 +1750,7 @@ def deploy_manifest(
17501750
"--branch",
17511751
"-b",
17521752
default="main",
1753-
help="Branch to deploy from. Connect auto-deploys when commits are pushed. [default: main]",
1753+
help="Branch to deploy from. [default: main]",
17541754
)
17551755
@click.option(
17561756
"--subdirectory",
@@ -1761,7 +1761,7 @@ def deploy_manifest(
17611761
@click.option(
17621762
"--polling/--no-polling",
17631763
default=True,
1764-
help="Enable/disable automatic redeployment when commits are pushed to the repository. [default: enabled]",
1764+
help="Enable/disable regular polling of the repository for updates. [default: enabled]",
17651765
)
17661766
@cli_exception_handler
17671767
@click.pass_context

0 commit comments

Comments
 (0)