@colony2/gitvend 0.0.5 → 0.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -10
- package/docs/gateway.md +15 -3
- package/examples/gitvend.yaml +0 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,13 +10,13 @@ The gateway sits between agents and GitHub. It holds your upstream GitHub tokens
|
|
|
10
10
|
checks each agent's signed permissions, and forwards authorized Git requests.
|
|
11
11
|
You can configure different upstream tokens for different organizations, deny
|
|
12
12
|
writes to protected branches, and control whether new repositories are created
|
|
13
|
-
publicly or privately with issues, projects,
|
|
13
|
+
publicly or privately with issues, projects, and wiki enabled.
|
|
14
14
|
|
|
15
15
|
The gateway supports GitHub and GitHub Enterprise-compatible endpoints. It needs
|
|
16
16
|
no database or GitHub App. Agents connect over HTTPS; GitHub's own access and
|
|
17
17
|
branch rules continue to apply.
|
|
18
18
|
|
|
19
|
-
[Set up and use the gateway →](https://github.com/colony-2/gitvend/blob/v0.0.
|
|
19
|
+
[Set up and use the gateway →](https://github.com/colony-2/gitvend/blob/v0.0.7/docs/gateway.md)
|
|
20
20
|
|
|
21
21
|
## JobDB plugin
|
|
22
22
|
|
|
@@ -29,7 +29,7 @@ The plugin keeps its signing key on the JobDB host, and the gateway verifies the
|
|
|
29
29
|
resulting tokens with the matching public key. Workers receive neither the
|
|
30
30
|
signing key nor the upstream GitHub token.
|
|
31
31
|
|
|
32
|
-
[Set up the JobDB plugin →](https://github.com/colony-2/gitvend/blob/v0.0.
|
|
32
|
+
[Set up the JobDB plugin →](https://github.com/colony-2/gitvend/blob/v0.0.7/docs/jobdb-secret-provider.md)
|
|
33
33
|
|
|
34
34
|
## Install
|
|
35
35
|
|
|
@@ -52,13 +52,13 @@ that includes `jobdb-gitvend-secret-provider` when using the plugin; older packa
|
|
|
52
52
|
may contain only `gitvend`.
|
|
53
53
|
|
|
54
54
|
For a container deployment, use the published image with the
|
|
55
|
-
[Docker Compose guide](https://github.com/colony-2/gitvend/blob/v0.0.
|
|
55
|
+
[Docker Compose guide](https://github.com/colony-2/gitvend/blob/v0.0.7/docs/docker-compose.md).
|
|
56
56
|
|
|
57
57
|
## Guides
|
|
58
58
|
|
|
59
|
-
- [Gateway setup, Git usage, and operations](https://github.com/colony-2/gitvend/blob/v0.0.
|
|
60
|
-
- [Repository creation controls](https://github.com/colony-2/gitvend/blob/v0.0.
|
|
61
|
-
- [JobDB plugin setup and issuer configuration](https://github.com/colony-2/gitvend/blob/v0.0.
|
|
62
|
-
- [Permission syntax](https://github.com/colony-2/gitvend/blob/v0.0.
|
|
63
|
-
- [Docker Compose deployment](https://github.com/colony-2/gitvend/blob/v0.0.
|
|
64
|
-
- [Developer guide: source builds, tests, and releases](https://github.com/colony-2/gitvend/blob/v0.0.
|
|
59
|
+
- [Gateway setup, Git usage, and operations](https://github.com/colony-2/gitvend/blob/v0.0.7/docs/gateway.md)
|
|
60
|
+
- [Repository creation controls](https://github.com/colony-2/gitvend/blob/v0.0.7/docs/gateway.md#repository-creation-defaults)
|
|
61
|
+
- [JobDB plugin setup and issuer configuration](https://github.com/colony-2/gitvend/blob/v0.0.7/docs/jobdb-secret-provider.md)
|
|
62
|
+
- [Permission syntax](https://github.com/colony-2/gitvend/blob/v0.0.7/docs/permission-syntax.md)
|
|
63
|
+
- [Docker Compose deployment](https://github.com/colony-2/gitvend/blob/v0.0.7/docs/docker-compose.md)
|
|
64
|
+
- [Developer guide: source builds, tests, and releases](https://github.com/colony-2/gitvend/blob/v0.0.7/docs/development.md)
|
package/docs/gateway.md
CHANGED
|
@@ -302,7 +302,6 @@ creation_defaults:
|
|
|
302
302
|
has_issues: false
|
|
303
303
|
has_projects: false
|
|
304
304
|
has_wiki: false
|
|
305
|
-
has_pull_requests: false
|
|
306
305
|
```
|
|
307
306
|
|
|
308
307
|
Supported settings use GitHub's field names:
|
|
@@ -310,7 +309,7 @@ Supported settings use GitHub's field names:
|
|
|
310
309
|
| Settings | Values and behavior |
|
|
311
310
|
| --- | --- |
|
|
312
311
|
| `visibility` | `private` (default) or `public`. |
|
|
313
|
-
| `has_issues`, `has_projects`, `has_wiki
|
|
312
|
+
| `has_issues`, `has_projects`, `has_wiki` | Optional booleans. An explicit `false` disables the feature; omission leaves GitHub's default. |
|
|
314
313
|
| `description`, `homepage` | Optional strings applied to newly created repositories. |
|
|
315
314
|
| `pull_request_creation_policy` | Optional `all` or `collaborators_only`. |
|
|
316
315
|
| `allow_squash_merge`, `allow_merge_commit`, `allow_rebase_merge` | Optional booleans. At least one merge method must remain available. |
|
|
@@ -322,7 +321,7 @@ are not accepted. GitHub organization policies and upstream permissions can
|
|
|
322
321
|
reject settings; these errors fail provisioning rather than silently changing
|
|
323
322
|
requested options. See the [GitHub creation API](https://docs.github.com/en/rest/repos/repos#create-an-organization-repository).
|
|
324
323
|
|
|
325
|
-
|
|
324
|
+
When configured, `pull_request_creation_policy` uses GitHub's
|
|
326
325
|
[repository update API](https://docs.github.com/en/rest/repos/repos#update-a-repository)
|
|
327
326
|
after creation or successful name reconciliation, before forwarding discovery
|
|
328
327
|
and the first push. The API credential must authorize these repository updates
|
|
@@ -333,6 +332,19 @@ enforcement. An existing repository found by the initial lookup is left unchange
|
|
|
333
332
|
including on a later retry or after a gateway restart. Gitvend does not store
|
|
334
333
|
pending provisioning state or roll back repository creation.
|
|
335
334
|
|
|
335
|
+
The error and audit reason include the failed settings step: an upstream HTTP
|
|
336
|
+
status, an omitted response field, or a field that differs from the requested
|
|
337
|
+
value. Raw upstream error bodies and credentials are not included. For a rejected
|
|
338
|
+
update, check the API credential's access to the new repository and its permission
|
|
339
|
+
to change settings (fine-grained GitHub tokens require **Administration: write**).
|
|
340
|
+
For omitted or mismatched fields, check the repository's actual pull request
|
|
341
|
+
settings and the upstream API's support for those fields. This failure occurs
|
|
342
|
+
before Gitvend forwards discovery or the push; it does not publish the commit.
|
|
343
|
+
Complete the settings on the existing repository before retrying the push:
|
|
344
|
+
retrying alone does not repeat the settings update. Omitting
|
|
345
|
+
`pull_request_creation_policy` skips this update for future repositories and
|
|
346
|
+
accepts the forge's default policy.
|
|
347
|
+
|
|
336
348
|
Defaults belong to the upstream provider, not to a JWT signing key or JobDB
|
|
337
349
|
tenant. Different providers can use different tokens and defaults for distinct
|
|
338
350
|
organizations/users. Provider selection uses the URL alias; overlapping owners
|
package/examples/gitvend.yaml
CHANGED
package/package.json
CHANGED