django_check: rename database param, add alias (#10700)

* django_check: rename database param, add alias

* add changelog frag

* Update plugins/modules/django_check.py

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky 2025-08-24 04:33:52 +12:00 committed by GitHub
commit 9f4bb3a788
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 8 additions and 4 deletions

View file

@ -0,0 +1,2 @@
minor_changes:
- django_check - rename parameter ``database`` to ``databases``, add alias for compatibility (https://github.com/ansible-collections/community.general/pull/10700).

View file

@ -19,12 +19,14 @@ extends_documentation_fragment:
- community.general.attributes - community.general.attributes
- community.general.django - community.general.django
options: options:
database: databases:
description: description:
- Specify databases to run checks against. - Specify databases to run checks against.
- If not specified, Django does not run database tests. - If not specified, Django does not run database tests.
- The parameter has been renamed to O(databases) in community.general 11.3.0. The old name is still available as an alias.
type: list type: list
elements: str elements: str
aliases: ["database"]
deploy: deploy:
description: description:
- Include additional checks relevant in a deployment setting. - Include additional checks relevant in a deployment setting.
@ -92,7 +94,7 @@ from ansible_collections.community.general.plugins.module_utils.cmd_runner impor
class DjangoCheck(DjangoModuleHelper): class DjangoCheck(DjangoModuleHelper):
module = dict( module = dict(
argument_spec=dict( argument_spec=dict(
database=dict(type="list", elements="str"), databases=dict(type="list", elements="str", aliases=["database"]),
deploy=dict(type="bool", default=False), deploy=dict(type="bool", default=False),
fail_level=dict(type="str", choices=["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"]), fail_level=dict(type="str", choices=["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"]),
tags=dict(type="list", elements="str"), tags=dict(type="list", elements="str"),
@ -101,14 +103,14 @@ class DjangoCheck(DjangoModuleHelper):
supports_check_mode=True, supports_check_mode=True,
) )
arg_formats = dict( arg_formats = dict(
database=cmd_runner_fmt.stack(cmd_runner_fmt.as_opt_val)("--database"), databases=cmd_runner_fmt.stack(cmd_runner_fmt.as_opt_val)("--database"),
deploy=cmd_runner_fmt.as_bool("--deploy"), deploy=cmd_runner_fmt.as_bool("--deploy"),
fail_level=cmd_runner_fmt.as_opt_val("--fail-level"), fail_level=cmd_runner_fmt.as_opt_val("--fail-level"),
tags=cmd_runner_fmt.stack(cmd_runner_fmt.as_opt_val)("--tag"), tags=cmd_runner_fmt.stack(cmd_runner_fmt.as_opt_val)("--tag"),
apps=cmd_runner_fmt.as_list(), apps=cmd_runner_fmt.as_list(),
) )
django_admin_cmd = "check" django_admin_cmd = "check"
django_admin_arg_order = "database deploy fail_level tags apps" django_admin_arg_order = "databases deploy fail_level tags apps"
def main(): def main():