From 583ae831f98eb2aaa0273b67b6d24a909f54ebc0 Mon Sep 17 00:00:00 2001 From: qwerty287 <80460567+qwerty287@users.noreply.github.com> Date: Sun, 31 Dec 2023 10:21:07 +0100 Subject: [PATCH 1/4] Add SSH settings --- docs.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs.md b/docs.md index 266e5d6..f23df42 100644 --- a/docs.md +++ b/docs.md @@ -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 @@ -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 | @@ -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 | +| `use_ssh` | `false` | 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 From d814c3ebd618c729eb52c02ccfc5456bcd3a0998 Mon Sep 17 00:00:00 2001 From: qwerty287 <80460567+qwerty287@users.noreply.github.com> Date: Sun, 31 Dec 2023 12:08:07 +0100 Subject: [PATCH 2/4] fix name --- docs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs.md b/docs.md index f23df42..a2c6b8e 100644 --- a/docs.md +++ b/docs.md @@ -61,6 +61,6 @@ clone: | `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 | -| `use_ssh` | `false` | SSH key for SSH clone | +| `ssh_key` | `false` | SSH key for SSH clone | [workflowClone]: https://woodpecker-ci.org/docs/usage/workflow-syntax#clone From 8cea49e7f2f9d167a43bbd6e88629d4decb3fac3 Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Sun, 31 Dec 2023 18:25:21 +0100 Subject: [PATCH 3/4] Update docs.md --- docs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs.md b/docs.md index a2c6b8e..63cbd27 100644 --- a/docs.md +++ b/docs.md @@ -61,6 +61,6 @@ clone: | `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 | +| `ssh_key` | _none_ | SSH key for SSH clone | [workflowClone]: https://woodpecker-ci.org/docs/usage/workflow-syntax#clone From 6486be3926cdf9bea8bd4555c6324ed03c63b3d3 Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Sun, 31 Dec 2023 18:25:34 +0100 Subject: [PATCH 4/4] Update docs.md --- docs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs.md b/docs.md index 63cbd27..8d233bf 100644 --- a/docs.md +++ b/docs.md @@ -61,6 +61,6 @@ clone: | `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 | +| `ssh_key` | _none_ | SSH key for SSH clone | [workflowClone]: https://woodpecker-ci.org/docs/usage/workflow-syntax#clone