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 }} {{- with $v.Default }}
defaultvalue: {{ . }} defaultvalue: {{ . }}
{{- end }} {{- end }}
{{- with $v.Required }} required: {{ default false $v.Required }}
required: {{ . }}
{{- end }}
{{ end -}} {{ end -}}
{{ end -}} {{ end -}}

View File

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