Skip to content

Commit 7f324dd

Browse files
Update README
1 parent aaa3562 commit 7f324dd

File tree

1 file changed

+10
-23
lines changed

1 file changed

+10
-23
lines changed

README.md

Lines changed: 10 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@ Tracks pull requests made to a Bitbucket repository.
44
A status of pending, success, or failure will be set on the pull request, which must be explicitly defined in your pipeline.
55

66
Currently only basic username/password authentication offers full functionality.
7-
Private key allows scanning for pull requests because this is pure git,
8-
but verifying merge status and setting status on pull requests is done through the Bitbucket REST Api for which
9-
SSH hasn't been tested yet.
7+
Private key allows scanning for pull requests because this is pure git, but verifying merge status and setting status on pull requests is done through the Bitbucket REST Api for which SSL hasn't been tested yet.
108

119
## Installing
1210

@@ -21,8 +19,7 @@ resource_types:
2119
repository: laurentverbruggen/concourse-bitbucket-pullrequest-resource
2220
```
2321
24-
See [concourse docs](http://concourse.ci/configuring-resource-types.html) for more details
25-
on adding `resource_types` to a pipeline config.
22+
See [concourse docs](http://concourse.ci/configuring-resource-types.html) for more details on adding `resource_types` to a pipeline config.
2623

2724
## Source Configuration
2825

@@ -40,16 +37,13 @@ on adding `resource_types` to a pipeline config.
4037
```
4138

4239
* `username`: *Optional.* Username for HTTP(S) auth when pulling/pushing.
43-
This is needed when only HTTP/HTTPS protocol for git is available (which does not support private key auth)
44-
and auth is required.
40+
This is needed when only HTTP/HTTPS protocol for git is available (which does not support private key auth) and auth is required.
4541

4642
* `password`: *Optional.* Password for HTTP(S) auth when pulling/pushing.
4743

48-
* `skip_ssl_verification`: *Optional.* Skips git ssl verification by exporting
49-
`GIT_SSL_NO_VERIFY=true`.
44+
* `skip_ssl_verification`: *Optional.* Skips git ssl verification by exporting `GIT_SSL_NO_VERIFY=true`.
5045

51-
* `git_config`: *Optional*. If specified as (list of pairs `name` and `value`)
52-
it will configure git global options, setting each name with each value.
46+
* `git_config`: *Optional*. If specified as (list of pairs `name` and `value`) it will configure git global options, setting each name with each value.
5347

5448
This can be useful to set options like `credential.helper` or similar.
5549

@@ -88,23 +82,16 @@ Submodules are initialized and updated recursively.
8882

8983
#### Parameters
9084

91-
* `depth`: *Optional.* If a positive integer is given, *shallow* clone the
92-
repository using the `--depth` option. Using this flag voids your warranty.
85+
* `depth`: *Optional.* If a positive integer is given, *shallow* clone the repository using the `--depth` option. Using this flag voids your warranty.
9386
Some things will stop working unless we have the entire history.
9487

95-
* `submodules`: *Optional.* If `none`, submodules will not be
96-
fetched. If specified as a list of paths, only the given paths will be
97-
fetched. If not specified, or if `all` is explicitly specified, all
98-
submodules are fetched.
88+
* `submodules`: *Optional.* If `none`, submodules will not be fetched. If specified as a list of paths, only the given paths will be fetched. If not specified, or if `all` is explicitly specified, all submodules are fetched.
9989

10090
* `disable_git_lfs`: *Optional.* If `true`, will not fetch Git LFS files.
10191

10292
#### GPG signature verification
10393

104-
If `commit_verification_keys` or `commit_verification_key_ids` is specified in
105-
the source configuration, it will additionally verify that the resulting commit
106-
has been GPG signed by one of the specified keys. It will error if this is not
107-
the case.
94+
If `commit_verification_keys` or `commit_verification_key_ids` is specified in the source configuration, it will additionally verify that the resulting commit has been GPG signed by one of the specified keys. It will error if this is not the case.
10895

10996
### `out`: Update the status of a pull request
11097

@@ -115,8 +102,8 @@ Set the status message on specified pull request.
115102
* `path`: *Required.* The path of the repository to reference the pull request.
116103

117104
* `status`: *Required.* The status of success, failure or pending.
118-
* [`on_success`](https://concourse.ci/on-success-step.html) and [`on_failure`](https://concourse.ci/on-failure-step.html)
119-
triggers may be useful for you when you wanted to reflect build result to the pull request (see the example below).
105+
106+
* [`on_success`](https://concourse.ci/on-success-step.html) and [`on_failure`](https://concourse.ci/on-failure-step.html) triggers may be useful for you when you wanted to reflect build result to the pull request (see the example below).
120107

121108
## Example pipeline
122109

0 commit comments

Comments
 (0)