diff --git a/templates/common-params.tpl b/templates/common-params.tpl index c067081..0a09e6b 100644 --- a/templates/common-params.tpl +++ b/templates/common-params.tpl @@ -8,8 +8,7 @@ type: string default: ca-bundle.crt description: | - Certificate Authority (CA) bundle filename on the `ssl-ca-directory` - Workspace. + Certificate Authority (CA) bundle filename in the SSL CA directory. - name: HTTP_PROXY type: string default: "" @@ -29,7 +28,8 @@ type: string default: "" description: | - Relative path to the default Workspace where the git repository will be present. + Path to the directory for storing the cloned Git repository, relative to the + output directory. - name: USER_HOME type: string default: "/home/git" @@ -39,16 +39,16 @@ type: string default: "true" description: | - Clean out the contents of the default Workspace before specific git operations occur, if data exists. + Clean out the contents of the default Workspace before specific Git operations occur, if data exists. - name: VERBOSE type: string default: "false" description: | - Log the commands executed. + Log the executed commands. - name: SSL_VERIFY type: string default: "true" description: | Sets the global `http.sslVerify` value, `false` is not advised unless you trust the remote repository. -{{- end -}} \ No newline at end of file +{{- end -}} diff --git a/templates/stepaction-params-git-clone.tpl b/templates/stepaction-params-git-clone.tpl index 6f5f19c..ddcb2ba 100644 --- a/templates/stepaction-params-git-clone.tpl +++ b/templates/stepaction-params-git-clone.tpl @@ -1,9 +1,9 @@ {{- define "stepaction_params_git_clone" -}} - name: OUTPUT_PATH description: | - A workspace that contains the fetched git repository, data will be placed on the root of the - Workspace, or on the relative path defined by the SUBDIRECTORY - parameter. + A directory that contains the fetched git repository. Cloned repo data is + placed in the root of the directory or in the relative path defined by the + `SUBDIRECTORY` parameter - name: SSH_DIRECTORY_PATH description: | A `.ssh` directory with private key, `known_hosts`, `config`, etc. @@ -14,15 +14,15 @@ - name: BASIC_AUTH_PATH default: "no-path" description: | - A Workspace containing a `.gitconfig` and `.git-credentials` files. - These will be copied to the user's home before Git commands run. All - other files in this Workspace are ignored. It is strongly recommended to + A directory containing `.gitconfig` and `.git-credentials` files. + These files are copied to the user home directory before Git commands run. + All other files in this Workspace are ignored. It is strongly recommended to use `ssh-directory` over `basic-auth` whenever possible, and to bind a - Secret to this Workspace over other volume types. + Secret to the Workspace providing this directory. - name: SSL_CA_DIRECTORY_PATH default: "no-path" description: | - A Workspace containing CA certificates, this will be used by Git to + A directory containing CA certificates. Git uses these certificates to verify the peer with when interacting with remote repositories using HTTPS. -{{- end -}} \ No newline at end of file +{{- end -}}