From 5776b9b82915354ba215f5f3983c0cf5181095af Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Wed, 3 Jan 2024 21:22:10 +0100 Subject: [PATCH] docs: always set required data attr (#4) --- cmd/wp-git-clone/templates/docs-data.yaml.tmpl | 4 +--- docs/data/data.yaml | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/cmd/wp-git-clone/templates/docs-data.yaml.tmpl b/cmd/wp-git-clone/templates/docs-data.yaml.tmpl index 04d1623..7342910 100644 --- a/cmd/wp-git-clone/templates/docs-data.yaml.tmpl +++ b/cmd/wp-git-clone/templates/docs-data.yaml.tmpl @@ -13,8 +13,6 @@ properties: {{- with $v.Default }} defaultvalue: {{ . }} {{- end }} - {{- with $v.Required }} - required: {{ . }} - {{- end }} + required: {{ default false $v.Required }} {{ end -}} {{ end -}} diff --git a/docs/data/data.yaml b/docs/data/data.yaml index 56febb6..7a77041 100644 --- a/docs/data/data.yaml +++ b/docs/data/data.yaml @@ -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