Skip to content

Commit

Permalink
Document SSH settings (#116)
Browse files Browse the repository at this point in the history 
was added back in 2.2.0  ( #75 )


---------

Co-authored-by: 6543 <[email protected]>
  • Loading branch information
@qwerty287 @6543
qwerty287 and 6543 authored Dec 31, 2023
1 parent 22c8f33 commit e6160be
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Its purpose is to clone your Git repository.
## Overriding Settings

You can manually define your `clone` step in order to change plugin or override some of the default settings.
Consult [the `clone` section of the pipeline documentation][pipelineClone] for more information;
Consult [the `clone` section of the pipeline documentation][workflowClone] for more information;
this documentation page only describes this plugin.

```yaml
Expand All @@ -47,7 +47,7 @@ clone:
| `tags` | `false` (except on tag event) | Fetches tags when set to true, default is false if event is not tag else true |
| `submodule_overrides` | _none_ | Override submodule urls |
| `submodule_update_remote` | `false` | Pass the --remote flag to git submodule update |
| `submodule_partial` | `true` | Update submodules via partial clone (depth=1) |
| `submodule_partial` | `true` | Update submodules via partial clone (depth=1) |
| `custom_ssl_path` | _none_ | Set path to custom cert |
| `custom_ssl_url` | _none_ | Set url to custom cert |
| `backoff` | `5sec` | Change backoff duration |
Expand All @@ -56,8 +56,11 @@ clone:
| `partial` | `true` (except if tags are fetched) | Only fetch the one commit and it's blob objects to resolve all files, overwrite depth with 1 |
| `home` | | Change HOME var for commands executed, fail if it does not exist |
| `remote` | $CI_REPO_CLONE_URL | Set the git remote url |
| `remote_ssh` | $CI_REPO_CLONE_SSH_URL | Set the git SSH remote url |
| `sha` | $CI_COMMIT_SHA | git commit hash to retrieve (use `sha: ''` to clone the `ref`) |
| `ref` | $CI_COMMIT_REF | Set the git reference to retrieve (use `ref: refs/heads/a_branch` and `sha: ''` to retrieve the head commit from the "a_branch" branch) |
| `path` | $CI_WORKSPACE | Set destination path to clone to |
| `use_ssh` | `false` | Clone using SSH |
| `ssh_key` | _none_ | SSH key for SSH clone |

[pipelineClone]: https://woodpecker-ci.org/docs/usage/pipeline-syntax#clone
[workflowClone]: https://woodpecker-ci.org/docs/usage/workflow-syntax#clone

0 comments on commit e6160be

Please sign in to comment.