gitd 0.10.0__tar.gz → 0.12.0__tar.gz

{gitd-0.10.0 → gitd-0.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: gitd
-Version: 0.10.0
+Version: 0.12.0
 Summary: Client for gitd: instant, secretless git checkouts for agent sandboxes
 Project-URL: Homepage, https://github.com/dooservice/gitd
 Project-URL: Source, https://github.com/dooservice/gitd/tree/main/sdk/python
@@ -46,12 +46,24 @@ No call takes a credential: gitd reads and publishes with the ones it keeps.
 | `update(path, *, branch, submodules, on_progress)` | To the tip of its branch, or of the branch given |
 | `checkout(path, commit, *, submodules, on_progress)` | To a commit, as a rollback does |
 | `describe(path)` | Its repository, commit, branch, uncommitted changes and submodules |
-| `publish(path, branch)` | Its commits pushed to a new branch |
+| `publish(path, branch, *, requested_by, pull_request, provenance, sandbox, update)` | Its commits pushed to a new branch, or with `update` an earlier publish's branch moved forward; its pull request opened or updated |
 | `remove(path)` | Deleted; its pool stays |
 | `probe(url)` | Whether it can be read, its default branch and branches |
 | `info()` | Which gitd answers, and how it makes workspaces here and why |
 | `audit(*, since, url, limit)` | Every publish, done or refused, newest first |
 
+```python
+from gitd import PullRequestOptions
+
+published = gitd.publish(
+    workspace.path, "agents/fix-login", update=True,
+    pull_request=PullRequestOptions(open=True, submodules=True, title="Fix the login", body="…"),
+)
+print(published.pull_request.url, published.pull_request.updated)
+for submodule in published.submodule_pull_requests:   # merged first, with a merge commit
+    print(submodule.path, submodule.pull_request or submodule.refused)
+```
+
 A refusal raises `GitdError`, with `reason` (`AUTH_REQUIRED`, `NOT_FOUND`, `PATH_REFUSED`,
 `BRANCH_REFUSED`, `BUSY`, …) and `said`, what git said. Decide from the reason, never from
 the message.

{gitd-0.10.0 → gitd-0.12.0}/README.md

@@ -29,12 +29,24 @@ No call takes a credential: gitd reads and publishes with the ones it keeps.
 | `update(path, *, branch, submodules, on_progress)` | To the tip of its branch, or of the branch given |
 | `checkout(path, commit, *, submodules, on_progress)` | To a commit, as a rollback does |
 | `describe(path)` | Its repository, commit, branch, uncommitted changes and submodules |
-| `publish(path, branch)` | Its commits pushed to a new branch |
+| `publish(path, branch, *, requested_by, pull_request, provenance, sandbox, update)` | Its commits pushed to a new branch, or with `update` an earlier publish's branch moved forward; its pull request opened or updated |
 | `remove(path)` | Deleted; its pool stays |
 | `probe(url)` | Whether it can be read, its default branch and branches |
 | `info()` | Which gitd answers, and how it makes workspaces here and why |
 | `audit(*, since, url, limit)` | Every publish, done or refused, newest first |
 
+```python
+from gitd import PullRequestOptions
+
+published = gitd.publish(
+    workspace.path, "agents/fix-login", update=True,
+    pull_request=PullRequestOptions(open=True, submodules=True, title="Fix the login", body="…"),
+)
+print(published.pull_request.url, published.pull_request.updated)
+for submodule in published.submodule_pull_requests:   # merged first, with a merge commit
+    print(submodule.path, submodule.pull_request or submodule.refused)
+```
+
 A refusal raises `GitdError`, with `reason` (`AUTH_REQUIRED`, `NOT_FOUND`, `PATH_REFUSED`,
 `BRANCH_REFUSED`, `BUSY`, …) and `said`, what git said. Decide from the reason, never from
 the message.

{gitd-0.10.0 → gitd-0.12.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "gitd"
-version = "0.10.0"
+version = "0.12.0"
 description = "Client for gitd: instant, secretless git checkouts for agent sandboxes"
 readme = "README.md"
 license = "Apache-2.0"

{gitd-0.10.0 → gitd-0.12.0}/src/gitd/__init__.py

@@ -23,6 +23,7 @@ from .models import (
     Refusal,
     Strategy,
     Submodule,
+    SubmodulePullRequest,
     Workspace,
 )
 from .publishing_settings import (
@@ -78,6 +79,7 @@ __all__ = [
     "Refusal",
     "Strategy",
     "Submodule",
+    "SubmodulePullRequest",
     "Workspace",
     "WarmLayer",
     "Endpoint",

{gitd-0.10.0 → gitd-0.12.0}/src/gitd/client.py

@@ -137,13 +137,20 @@ class Gitd:
         pull_request: PullRequestOptions | None = None,
         provenance: Provenance | None = None,
         sandbox: str = "",
+        update: bool = False,
     ) -> Published:
         """Pushes what was committed in a workspace to a new branch, with the credential gitd
         keeps, and opens its pull request when the publishing settings or pull_request say
         so. requested_by is who asked for the work, as their account on the host. With
-        sandbox, and path empty, publishes the branch a sandbox pushed through the endpoint."""
+        sandbox, and path empty, publishes the branch a sandbox pushed through the endpoint.
+
+        With update, the branch may exist from an earlier publish: it is moved forward, only
+        ever as a fast-forward (BRANCH_EXISTS otherwise), and the pull request open from it is
+        updated rather than another opened. An update bringing nothing beyond what gitd
+        published to the branch pushes nothing and still opens or updates the pull requests,
+        so a publish whose pull request failed is retried by publishing again."""
         request: Any = messages.PublishRequest(
-            path=path, branch=branch, requested_by=requested_by, sandbox=sandbox
+            path=path, branch=branch, requested_by=requested_by, sandbox=sandbox, update=update
         )
         if pull_request is not None:
             request.pull_request.CopyFrom(pull_request.to_message())

{gitd-0.10.0 → gitd-0.12.0}/src/gitd/contract.json

@@ -287,6 +287,10 @@
                 {
                   "name": "REASON_LIMIT_REACHED",
                   "number": 15
+                },
+                {
+                  "name": "REASON_BRANCH_EXISTS",
+                  "number": 16
                 }
               ]
             }
@@ -989,6 +993,13 @@
               "label": "LABEL_OPTIONAL",
               "type": "TYPE_STRING",
               "jsonName": "sandbox"
+            },
+            {
+              "name": "update",
+              "number": 8,
+              "label": "LABEL_OPTIONAL",
+              "type": "TYPE_BOOL",
+              "jsonName": "update"
             }
           ]
         },
@@ -1064,6 +1075,13 @@
               "oneofIndex": 0,
               "jsonName": "draft",
               "proto3Optional": true
+            },
+            {
+              "name": "submodules",
+              "number": 6,
+              "label": "LABEL_OPTIONAL",
+              "type": "TYPE_BOOL",
+              "jsonName": "submodules"
             }
           ],
           "oneofDecl": [
@@ -1088,6 +1106,48 @@
               "label": "LABEL_OPTIONAL",
               "type": "TYPE_INT64",
               "jsonName": "number"
+            },
+            {
+              "name": "updated",
+              "number": 3,
+              "label": "LABEL_OPTIONAL",
+              "type": "TYPE_BOOL",
+              "jsonName": "updated"
+            }
+          ]
+        },
+        {
+          "name": "SubmodulePullRequest",
+          "field": [
+            {
+              "name": "path",
+              "number": 1,
+              "label": "LABEL_OPTIONAL",
+              "type": "TYPE_STRING",
+              "jsonName": "path"
+            },
+            {
+              "name": "url",
+              "number": 2,
+              "label": "LABEL_OPTIONAL",
+              "type": "TYPE_STRING",
+              "jsonName": "url"
+            },
+            {
+              "name": "pull_request",
+              "number": 3,
+              "label": "LABEL_OPTIONAL",
+              "type": "TYPE_MESSAGE",
+              "typeName": ".gitd.v1.OpenedPullRequest",
+              "jsonName": "pullRequest"
+            },
+            {
+              "name": "failure",
+              "number": 4,
+              "label": "LABEL_OPTIONAL",
+              "type": "TYPE_MESSAGE",
+              "typeName": ".gitd.v1.GitFailure",
+              "jsonName": "failure"
             }
           ]
         },
@@ -1165,6 +1225,14 @@
               "type": "TYPE_MESSAGE",
               "typeName": ".gitd.v1.GitFailure",
               "jsonName": "pullRequestFailure"
+            },
+            {
+              "name": "submodule_pull_requests",
+              "number": 6,
+              "label": "LABEL_REPEATED",
+              "type": "TYPE_MESSAGE",
+              "typeName": ".gitd.v1.SubmodulePullRequest",
+              "jsonName": "submodulePullRequests"
             }
           ]
         },
@@ -1932,6 +2000,14 @@
               "label": "LABEL_OPTIONAL",
               "type": "TYPE_STRING",
               "jsonName": "sandbox"
+            },
+            {
+              "name": "submodule_pull_requests",
+              "number": 14,
+              "label": "LABEL_REPEATED",
+              "type": "TYPE_MESSAGE",
+              "typeName": ".gitd.v1.SubmodulePullRequest",
+              "jsonName": "submodulePullRequests"
             }
           ]
         },

{gitd-0.10.0 → gitd-0.12.0}/src/gitd/models.py

@@ -200,15 +200,42 @@ class Refusal:
         return messages.REASON.name(failure.reason).removeprefix(REASON_PREFIX)
 
 
+@dataclass(frozen=True)
+class SubmodulePullRequest:
+    """The pull request of one submodule, at path in the workspace and of the repository at
+    url, or why it could not be opened."""
+
+    path: str
+    url: str
+    pull_request: OpenedPullRequest | None = None
+    refused: Refusal | None = None
+
+    @classmethod
+    def from_message(cls, submodule: Any) -> SubmodulePullRequest:
+        return cls(
+            path=submodule.path,
+            url=submodule.url,
+            pull_request=(
+                OpenedPullRequest.from_message(submodule.pull_request)
+                if submodule.HasField("pull_request")
+                else None
+            ),
+            refused=Refusal.from_message(submodule.failure) if submodule.HasField("failure") else None,
+        )
+
+
 @dataclass(frozen=True)
 class Published:
     """What a publish pushed: the workspace's repository first, then each submodule; the
-    pull request it opened, or why it could not, the branch being published either way."""
+    pull request it opened or updated, or why it could not, the branch being published
+    either way; and each submodule's, when asked for. An update that brought nothing new
+    lists the workspace's repository with no subjects."""
 
     branch: str
     repositories: list[PublishedRepository]
     pull_request: OpenedPullRequest | None = None
     pull_request_refused: Refusal | None = None
+    submodule_pull_requests: list[SubmodulePullRequest] = field(default_factory=list)
 
     @classmethod
     def from_message(cls, response: Any) -> Published:
@@ -226,6 +253,9 @@ class Published:
                 if response.HasField("pull_request_failure")
                 else None
             ),
+            submodule_pull_requests=[
+                SubmodulePullRequest.from_message(submodule) for submodule in response.submodule_pull_requests
+            ],
         )
 
 
@@ -310,6 +340,7 @@ class AuditEntry:
     pull_request_refused: Refusal | None = None
     change: ConfigurationChange | None = None
     provenance: Provenance | None = None
+    submodule_pull_requests: list[SubmodulePullRequest] = field(default_factory=list)
 
     @classmethod
     def from_message(cls, entry: Any) -> AuditEntry:
@@ -332,4 +363,7 @@ class AuditEntry:
             ),
             change=ConfigurationChange.from_message(entry.change) if entry.HasField("change") else None,
             provenance=Provenance.from_message(entry.provenance) if entry.HasField("provenance") else None,
+            submodule_pull_requests=[
+                SubmodulePullRequest.from_message(submodule) for submodule in entry.submodule_pull_requests
+            ],
         )

{gitd-0.10.0 → gitd-0.12.0}/src/gitd/publishing_settings.py

@@ -156,17 +156,20 @@ class Preset:
 class PullRequestOptions:
     """A publish's own say on its pull request: open one even when the settings open them
     only when asked, its title (the newest commit's subject when empty), the text before
-    what gitd checked, the branch it merges into, and whether it is a draft."""
+    what gitd checked, the branch it merges into, and whether it is a draft. submodules
+    opens one too in each submodule's repository, with the same title, into the branch
+    .gitmodules names for it or its default branch: to be merged first, with a merge commit."""
 
     open: bool = False
     title: str = ""
     body: str = ""
     base: str = ""
     draft: bool | None = None
+    submodules: bool = False
 
     def to_message(self) -> Any:
         message: Any = messages.PullRequestOptions(
-            open=self.open, title=self.title, body=self.body, base=self.base
+            open=self.open, title=self.title, body=self.body, base=self.base, submodules=self.submodules
         )
         if self.draft is not None:
             message.draft = self.draft
@@ -201,11 +204,13 @@ class Provenance:
 
 @dataclass(frozen=True)
 class OpenedPullRequest:
-    """A pull request gitd opened."""
+    """A pull request gitd opened; updated says it was already open from the branch, and
+    gitd updated its title and body."""
 
     url: str
     number: int
+    updated: bool = False
 
     @classmethod
     def from_message(cls, opened: Any) -> OpenedPullRequest:
-        return cls(url=opened.url, number=opened.number)
+        return cls(url=opened.url, number=opened.number, updated=opened.updated)