Skip to content

Commit d05b3bc

Browse files
committed
tidy docs
1 parent b8d41b4 commit d05b3bc

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
@@ -16,6 +16,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1616
used automatically. `rsconnect login` sets the server as default unless
1717
`--no-set-default` is passed. `CONNECT_SERVER` still takes precedence.
1818
- New `environment` subcommand for managing execution environments on Connect.
19+
- Added `rsconnect deploy git` command to create a [git-backed deployment](https://docs.posit.co/connect/user/git-backed/).
20+
Use `--branch` to specify a branch (default: main) and `--subdirectory` to deploy content from a subdirectory.
1921

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

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

2729
### Added
2830

29-
- Added `rsconnect deploy git` command to create a [git-backed deployment](https://docs.posit.co/connect/user/git-backed/).
30-
Use `--branch` to specify a branch (default: main) and `--subdirectory` to deploy content from a subdirectory.
3131
- `rsconnect content get-lockfile` command allows fetching a lockfile with the
3232
dependencies installed by connect to run the deployed content
3333
- `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
@@ -730,8 +730,6 @@ def content_deploy(
730730
def get_repository(self, content_guid: str) -> Optional[RepositoryInfo]:
731731
"""Get git repository configuration for a content item.
732732
733-
GET /v1/content/{guid}/repository
734-
735733
:param content_guid: The GUID of the content item
736734
:return: Repository configuration if git-managed, None otherwise
737735
"""
@@ -753,13 +751,11 @@ def set_repository(
753751
) -> RepositoryInfo:
754752
"""Create or overwrite git repository configuration for a content item.
755753
756-
PUT /v1/content/{guid}/repository
757-
758754
:param content_guid: The GUID of the content item
759755
:param repository: URL of the git repository (https:// only)
760756
:param branch: Branch to deploy from (default: main)
761757
:param directory: Directory containing manifest.json (default: .)
762-
:param polling: Enable auto-redeploy when commits are pushed (default: True)
758+
:param polling: Whether the git repository should be regularly polled (default: True)
763759
:return: The repository configuration
764760
"""
765761
body = {
@@ -785,15 +781,13 @@ def update_repository(
785781
) -> RepositoryInfo:
786782
"""Partially update git repository configuration for a content item.
787783
788-
PATCH /v1/content/{guid}/repository
789-
790784
Only fields that are provided will be updated.
791785
792786
:param content_guid: The GUID of the content item
793787
:param repository: URL of the git repository (https:// only)
794788
:param branch: Branch to deploy from
795789
:param directory: Directory containing manifest.json
796-
:param polling: Enable auto-redeploy when commits are pushed
790+
:param polling: Whether the git repository should be regularly polled
797791
:return: The updated repository configuration
798792
"""
799793
body: dict[str, str | bool] = {}
@@ -816,8 +810,6 @@ def update_repository(
816810
def delete_repository(self, content_guid: str) -> None:
817811
"""Remove git repository configuration from a content item.
818812
819-
DELETE /v1/content/{guid}/repository
820-
821813
:param content_guid: The GUID of the content item
822814
"""
823815
response = self.delete("v1/content/%s/repository" % content_guid)
@@ -833,8 +825,6 @@ def create_bundle_from_repository(
833825
) -> RepositoryBundleOutput:
834826
"""Create a bundle from a git repository location.
835827
836-
POST /v1/content/{guid}/repository/bundle
837-
838828
This triggers Connect to clone the repository and create a bundle.
839829
If the content item has existing git configuration, those values are used
840830
as defaults; provided parameters will override them.
@@ -875,7 +865,7 @@ def deploy_git(
875865
"""Deploy content from a git repository.
876866
877867
Creates or updates a git-backed content item in Posit Connect. Connect will clone
878-
the repository and automatically redeploy when commits are pushed (if polling is enabled).
868+
the repository and regularly poll it for updates.
879869
880870
:param app_id: Existing content ID/GUID to update, or None to create new content
881871
:param name: Name for the content item (used if creating new)
@@ -884,7 +874,7 @@ def deploy_git(
884874
:param subdirectory: Subdirectory containing manifest.json
885875
:param title: Title for the content
886876
:param env_vars: Environment variables to set
887-
:param polling: Enable auto-redeploy when commits are pushed (default: True)
877+
:param polling: Whether the git repository should be regularly polled (default: True)
888878
:param activate: Whether to activate the deployment (False = draft mode)
889879
:return: Deployment result with task_id, app info, etc.
890880
"""
@@ -1617,7 +1607,7 @@ def deploy_git(self, activate: bool = True):
16171607
"""Deploy content from a remote git repository.
16181608
16191609
Creates a git-backed content item in Posit Connect. Connect will clone
1620-
the repository and automatically redeploy when commits are pushed.
1610+
the repository and regularly poll it for updates.
16211611
"""
16221612
if not isinstance(self.client, RSConnectClient):
16231613
raise RSConnectException(

‎rsconnect/main.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1739,7 +1739,7 @@ def deploy_manifest(
17391739
help=(
17401740
"Deploy content to Posit Connect directly from a remote Git repository. "
17411741
"The repository must contain a manifest.json file (in the root or specified subdirectory). "
1742-
"Connect will periodically check for updates and redeploy automatically when commits are pushed."
1742+
"Connect will regularly poll the repository for updates."
17431743
"\n\n"
17441744
"This command creates a new git-backed content item. To update an existing git-backed "
17451745
"content item, use the --app-id option with the content's GUID."
@@ -1758,7 +1758,7 @@ def deploy_manifest(
17581758
"--branch",
17591759
"-b",
17601760
default="main",
1761-
help="Branch to deploy from. Connect auto-deploys when commits are pushed. [default: main]",
1761+
help="Branch to deploy from. [default: main]",
17621762
)
17631763
@click.option(
17641764
"--subdirectory",
@@ -1769,7 +1769,7 @@ def deploy_manifest(
17691769
@click.option(
17701770
"--polling/--no-polling",
17711771
default=True,
1772-
help="Enable/disable automatic redeployment when commits are pushed to the repository. [default: enabled]",
1772+
help="Enable/disable regular polling of the repository for updates. [default: enabled]",
17731773
)
17741774
@cli_exception_handler
17751775
@click.pass_context

0 commit comments

Comments
 (0)