1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-04-16 17:01:30 +00:00

Adjust booleans in packaging modules. (#5154)

This commit is contained in:
Felix Fontein 2022-08-24 19:59:13 +02:00 committed by GitHub
parent be2de15c66
commit ddc989ec6d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
38 changed files with 242 additions and 228 deletions

View file

@ -25,12 +25,12 @@ options:
description:
- Install packages from local cache, if the packages were installed before
type: bool
default: 'no'
default: false
production:
description:
- Install with --production flag
type: bool
default: 'no'
default: false
path:
type: path
description:
@ -80,7 +80,7 @@ EXAMPLES = '''
- npm:
path: /app/location
name: bower
global: no
global: false
- community.general.bower:
path: /app/location
relative_execpath: node_modules/.bin

View file

@ -45,7 +45,7 @@ options:
- Only applies if state is C(present). If set removes any gems on the
target host that are not in the gemfile
type: bool
default: 'no'
default: false
gemfile:
type: path
description:
@ -55,19 +55,19 @@ options:
description:
- If set only installs gems from the cache on the target host
type: bool
default: 'no'
default: false
deployment_mode:
description:
- Only applies if state is C(present). If set it will install gems in
./vendor/bundle instead of the default location. Requires a Gemfile.lock
file to have been created prior
type: bool
default: 'no'
default: false
user_install:
description:
- Only applies if state is C(present). Installs gems in the local user's cache or for all users
type: bool
default: 'yes'
default: true
gem_path:
type: path
description:
@ -106,7 +106,7 @@ EXAMPLES = '''
- name: Install gems into ./vendor/bundle
community.general.bundler:
state: present
deployment_mode: yes
deployment_mode: true
- name: Install gems using a Gemfile in another directory
community.general.bundler:

View file

@ -126,12 +126,12 @@ EXAMPLES = '''
command: create-project
arguments: package/package /path/to/project ~1.0
working_dir: /path/to/project
prefer_dist: yes
prefer_dist: true
- name: Install a package globally
community.general.composer:
command: require
global_command: yes
global_command: true
arguments: my/package
'''

View file

@ -31,7 +31,7 @@ options:
description:
- Do not run unit tests.
type: bool
default: no
default: false
locallib:
description:
- Specify the install base to install modules.
@ -44,12 +44,12 @@ options:
description:
- Use the mirror's index file instead of the CPAN Meta DB.
type: bool
default: no
default: false
installdeps:
description:
- Only install dependencies.
type: bool
default: no
default: false
version:
description:
- Version specification for the perl module. When I(mode) is C(new), C(cpanm) version operators are accepted.
@ -122,7 +122,7 @@ EXAMPLES = '''
mirror: 'http://cpan.cpantesters.org/'
- name: Install Dancer perl package into the system root path
become: yes
become: true
community.general.cpanm:
name: Dancer

View file

@ -34,7 +34,7 @@ options:
have any effect, the environment must be deleted and newly
created.
type: bool
default: 'no'
default: false
virtualenv_command:
type: str
description:

View file

@ -38,7 +38,7 @@ options:
- Whether to include dependencies or not.
required: false
type: bool
default: "yes"
default: true
repository:
type: str
description:
@ -50,7 +50,7 @@ options:
- Install gem in user's local gems cache or for all users
required: false
type: bool
default: "yes"
default: true
executable:
type: path
description:
@ -80,7 +80,7 @@ options:
description:
- Rewrite the shebang line on installed scripts to use /usr/bin/env.
required: false
default: "no"
default: false
type: bool
version:
type: str
@ -91,13 +91,13 @@ options:
description:
- Allow installation of pre-release versions of the gem.
required: false
default: "no"
default: false
type: bool
include_doc:
description:
- Install with or without docs.
required: false
default: "no"
default: false
type: bool
build_flags:
type: str
@ -108,7 +108,7 @@ options:
description:
- Force gem to install, bypassing dependency checks.
required: false
default: "no"
default: false
type: bool
author:
- "Ansible Core Team"

View file

@ -83,7 +83,7 @@ options:
responds to an initial request with a 401 status. Since some basic auth services do not properly
send a 401, logins will fail. This option forces the sending of the Basic authentication header
upon initial request.
default: 'no'
default: false
type: bool
version_added: '0.2.0'
dest:
@ -105,9 +105,9 @@ options:
default: 10
validate_certs:
description:
- If C(no), SSL certificates will not be validated. This should only be set to C(no) when no other option exists.
- If C(false), SSL certificates will not be validated. This should only be set to C(false) when no other option exists.
type: bool
default: 'yes'
default: true
client_cert:
description:
- PEM formatted certificate chain file to be used for SSL client authentication.
@ -122,11 +122,11 @@ options:
version_added: '1.3.0'
keep_name:
description:
- If C(yes), the downloaded artifact's name is preserved, i.e the version number remains part of it.
- If C(true), the downloaded artifact's name is preserved, i.e the version number remains part of it.
- This option only has effect when C(dest) is a directory and C(version) is set to C(latest) or C(version_by_spec)
is defined.
type: bool
default: 'no'
default: false
verify_checksum:
type: str
description:
@ -214,7 +214,7 @@ EXAMPLES = '''
artifact_id: spring-core
group_id: org.springframework
dest: /tmp/
keep_name: yes
keep_name: true
- name: Download the latest version of the JUnit framework artifact from Maven local
community.general.maven_artifact:

View file

@ -35,7 +35,7 @@ options:
description:
- Install the node.js library globally.
required: false
default: no
default: false
type: bool
executable:
description:
@ -48,23 +48,23 @@ options:
- Use the C(--ignore-scripts) flag when installing.
required: false
type: bool
default: no
default: false
unsafe_perm:
description:
- Use the C(--unsafe-perm) flag when installing.
type: bool
default: no
default: false
ci:
description:
- Install packages based on package-lock file, same as running C(npm ci).
type: bool
default: no
default: false
production:
description:
- Install dependencies in production mode, excluding devDependencies.
required: false
type: bool
default: no
default: false
registry:
description:
- The registry to install modules from.
@ -81,13 +81,13 @@ options:
description:
- Use the C(--no-optional) flag when installing.
type: bool
default: no
default: false
version_added: 2.0.0
no_bin_links:
description:
- Use the C(--no-bin-links) flag when installing.
type: bool
default: no
default: false
version_added: 2.5.0
requirements:
- npm installed in bin path (recommended /usr/local/bin)
@ -108,12 +108,12 @@ EXAMPLES = r'''
- name: Install "coffee-script" node.js package globally.
community.general.npm:
name: coffee-script
global: yes
global: true
- name: Remove the globally package "coffee-script".
community.general.npm:
name: coffee-script
global: yes
global: true
state: absent
- name: Install "coffee-script" node.js package from custom registry.

View file

@ -44,7 +44,7 @@ options:
description:
- Install the node.js library globally
required: false
default: no
default: false
type: bool
executable:
type: path
@ -56,14 +56,14 @@ options:
- Use the --ignore-scripts flag when installing.
required: false
type: bool
default: no
default: false
production:
description:
- Install dependencies in production mode.
- Yarn will ignore any dependencies under devDependencies in package.json
required: false
type: bool
default: no
default: false
registry:
type: str
description:
@ -96,12 +96,12 @@ EXAMPLES = '''
- name: Install "imagemin" node.js package globally.
community.general.yarn:
name: imagemin
global: yes
global: true
- name: Remove the globally-installed package "imagemin".
community.general.yarn:
name: imagemin
global: yes
global: true
state: absent
- name: Install "imagemin" node.js package from custom registry.