Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document SSH settings #116

Merged
merged 4 commits into from
Dec 31, 2023
Merged

Document SSH settings #116

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
583ae83
Add SSH settings
qwerty287 Dec 31, 2023
d814c3e
fix name
qwerty287 Dec 31, 2023
8cea49e
Update docs.md
6543 Dec 31, 2023
6486be3
Update docs.md
6543 Dec 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs.md
View file
Open in desktop
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` | `false` | SSH key for SSH clone |
6543 marked this conversation as resolved.
Show resolved Hide resolved
6543 marked this conversation as resolved.
Show resolved Hide resolved

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