0
0
mirror of https://github.com/thegeeklab/wp-git-clone.git synced 2024-11-22 00:10:39 +00:00

docs: always set required data attr (#4)

This commit is contained in:
Robert Kaussow 2024-01-03 21:22:10 +01:00 committed by GitHub
parent 6b506e6a31
commit 5776b9b829
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 3 deletions

View File

@ -13,8 +13,6 @@ properties:
{{- with $v.Default }}
defaultvalue: {{ . }}
{{- end }}
{{- with $v.Required }}
required: {{ . }}
{{- end }}
required: {{ default false $v.Required }}
{{ end -}}
{{ end -}}

View File

@ -5,24 +5,28 @@ properties:
Change branch name.
type: string
defaultvalue: "main"
required: false
- name: commit_ref
description: |
Git commit ref.
type: string
defaultvalue: "refs/heads/main"
required: false
- name: commit_sha
description: |
Git commit sha.
type: string
defaultvalue: $CI_COMMIT_SHA
required: false
- name: depth
description: |
Clone depth.
type: integer
defaultvalue: 0
required: false
- name: insecure_skip_ssl_verify
description: |
@ -31,79 +35,93 @@ properties:
Activating this option is insecure and should be avoided in most cases.
type: bool
defaultvalue: false
required: false
- name: lfs
description: |
Whether to retrieve LFS content if available.
type: bool
defaultvalue: true
required: false
- name: partial
description: |
Enable/disable partial clone.
type: bool
defaultvalue: false
required: false
- name: recursive
description: |
Clone submodules.
type: bool
defaultvalue: true
required: false
- name: remote
description: |
Git remote HTTP clone url.
type: string
defaultvalue: $CI_REPO_CLONE_URL
required: false
- name: remote_ssh
description: |
Git remote SSH clone url.
type: string
defaultvalue: $CI_REPO_CLONE_SSH_URL
required: false
- name: safe_directory
description: |
Define/replace safe directories.
type: string
defaultvalue: $CI_WORKSPACE
required: false
- name: ssh_key
description: |
Private key for SSH clone.
type: string
required: false
- name: submodule_override
description: |
JSON map of submodule overrides.
type: generic
required: false
- name: submodules_partial
description: |
Update submodules via partial clone (`depth=1`).
type: bool
defaultvalue: true
required: false
- name: submodules_update_remote
description: |
Update remote submodules.
type: bool
defaultvalue: false
required: false
- name: tags
description: |
Fetch git tags during clone.
type: bool
defaultvalue: true
required: false
- name: use_ssh
description: |
Using SSH for git clone.
type: bool
defaultvalue: false
required: false
- name: workdir
description: |
Path to clone git repository.
type: string
defaultvalue: $CI_WORKSPACE
required: false