Skip to content

Commit 983cb33

Browse files
committed
add information about uri
1 parent 933ad60 commit 983cb33

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,12 @@ In your bosh deployment manifest, add to the `groundcrew.additional_resource_typ
2222

2323
* `access_token`: *Required.* An access token with `repo:status` access.
2424

25+
* `uri`: *Optional.* The URI to the github repo. By default, it assumes
26+
https://github.com/`repo`.
27+
2528
* `base_url`: *Optional* The base URL for the Concourse deployment, used for
26-
linking to builds. If not present, no link is provided on the Github pull
27-
request.
29+
linking to builds. On newer versions of Concourse ( >= v0.71.0) , the resource will
30+
automatically sets the URL.
2831

2932
* `private_key`: *Optional.* Private key to use when pulling/pushing.
3033
Example:
@@ -36,6 +39,7 @@ In your bosh deployment manifest, add to the `groundcrew.additional_resource_typ
3639
DWiJL+OFeg9kawcUL6hQ8JeXPhlImG6RTUffma9+iGQyyBMCGd1l
3740
-----END RSA PRIVATE KEY-----
3841
```
42+
3943
* `api_endpoint`: *Optional.* If the repository is located on a GitHub Enterprise
4044
instance you need to specify the base api endpoint (e.g. "https://\<hostname\>/api/v3/").
4145

0 commit comments

Comments
 (0)