jenkins_plugin: doc: Specify version as string (#18858)
If the plugin version expected is, say '1.20', then specifying it as... version: 1.20 ... will make the YAML parser interpret it as a float, and the value obtained by the module will be 1.2 instead of 1.20, which will cause downloading of wrong version of the module. This patch updates the docs so that users don't face this issue.
This commit is contained in:
parent
8c5d321a23
commit
e907622121
1 changed files with 4 additions and 2 deletions
|
@ -120,6 +120,8 @@ options:
|
||||||
manually.
|
manually.
|
||||||
- It might take longer to verify that the correct version is installed.
|
- It might take longer to verify that the correct version is installed.
|
||||||
This is especially true if a specific version number is specified.
|
This is especially true if a specific version number is specified.
|
||||||
|
- Quote the version to prevent the value to be interpreted as float. For
|
||||||
|
example if C(1.20) would be unquoted, it would become C(1.2).
|
||||||
with_dependencies:
|
with_dependencies:
|
||||||
required: false
|
required: false
|
||||||
choices: ['yes', 'no']
|
choices: ['yes', 'no']
|
||||||
|
@ -159,7 +161,7 @@ EXAMPLES = '''
|
||||||
- name: Install specific version of the plugin
|
- name: Install specific version of the plugin
|
||||||
jenkins_plugin:
|
jenkins_plugin:
|
||||||
name: token-macro
|
name: token-macro
|
||||||
version: 1.15
|
version: "1.15"
|
||||||
|
|
||||||
- name: Pin the plugin
|
- name: Pin the plugin
|
||||||
jenkins_plugin:
|
jenkins_plugin:
|
||||||
|
@ -212,7 +214,7 @@ EXAMPLES = '''
|
||||||
token-macro:
|
token-macro:
|
||||||
enabled: yes
|
enabled: yes
|
||||||
build-pipeline-plugin:
|
build-pipeline-plugin:
|
||||||
version: 1.4.9
|
version: "1.4.9"
|
||||||
pinned: no
|
pinned: no
|
||||||
enabled: yes
|
enabled: yes
|
||||||
tasks:
|
tasks:
|
||||||
|
|
Loading…
Reference in a new issue