Added documentation for collectstatic --clear.

[StuartMacKay]

SUMMARY

Documents the clear argument to the django_manage module that can be used to delete existing files when the collectstatic management command is run.

ISSUE TYPE

• Docs Pull Request

COMPONENT NAME

django_manage

ANSIBLE VERSION

ansible 2.5.5
  config file = /home/stuart/.ansible.cfg
  configured module search path = [u'/home/stuart/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python2.7/dist-packages/ansible
  executable location = /usr/bin/ansible
  python version = 2.7.12 (default, Dec  4 2017, 14:50:18) [GCC 5.4.0 20160609]

ADDITIONAL INFORMATION

When ansible/ansible-modules-core#1810 was submitted there was no corresponding update to the documentation for the django_manage module.

The PR was merged on 17 Sep 2015 but I do not know what version this was added to. This will need to be added to the change here.

Sample output from anisble when running the command.

changed: [papyrus.local] => {
    "app_path": "/webapps/papyrus/papyrus/backend", 
    "changed": [
        ...
        "Deleting 'rest_framework/js/csrf.js'", 
        "Deleting 'rest_framework/js/bootstrap.min.js'", 
        "Deleting 'rest_framework/js/default.js'", 
        ...
        "Copying '/webapps/papyrus/lib/python3.6/site-packages/rest_framework/static/rest_framework/js/csrf.js'", 
        "Copying '/webapps/papyrus/lib/python3.6/site-packages/rest_framework/static/rest_framework/js/bootstrap.min.js'", 
        "Copying '/webapps/papyrus/lib/python3.6/site-packages/rest_framework/static/rest_framework/js/default.js'", 
        ...
    "cmd": "./manage.py collectstatic --noinput --settings=settings --clear", 
    "out": "Deleting ...
   "pythonpath": null, 
    "settings": "papyrus.settings", 
    "virtualenv": "/webapps/papyrus"
}

[ansibot]

cc @scottanderson42 @tastychutney
click here for bot help

[ansibot]

The test ansible-test sanity --test pep8 [explain] failed with 2 errors:

lib/ansible/modules/web_infrastructure/django_manage.py:59:82: W291 trailing whitespace
lib/ansible/modules/web_infrastructure/django_manage.py:63:15: W291 trailing whitespace

The test ansible-test sanity --test validate-modules [explain] failed with 1 error:

lib/ansible/modules/web_infrastructure/django_manage.py:0:0: E309 version_added for new option (clear) should be 2.7. Currently 0.0

click here for bot help

[ansibot]

The test ansible-test sanity --test validate-modules [explain] failed with 1 error:

lib/ansible/modules/web_infrastructure/django_manage.py:0:0: E309 version_added for new option (clear) should be 2.7. Currently 0.0

click here for bot help

[gundalow]

The C(--noinput) argument will be added automatically.

[gundalow]

default: no

[ansibot]

The test ansible-test sanity --test validate-modules [explain] failed with 1 error:

lib/ansible/modules/web_infrastructure/django_manage.py:0:0: E309 version_added for new option (clear) should be 2.7. Currently 0.0

click here for bot help

[StuartMacKay]

@gundalow: this is just a documentation update that should be applied retrospectively and not related to an upcoming release. I searched for a changelog that would give me an idea in which version PR for the clear argument was added but did not find anything.

Any ideas on how to deal with this failing test and how to move this forward?

[gundalow]

@StuartMacKay What you did was correct so I've merged this. I'll create a backport to get this into stable-2.7

Thank you very much for your first PR, apologies I missed your comment above, unfortunatly I get a lot of GitHub email so I sometime miss the odd PR. Though merged now!

Looking at the module, there seem to be other docs issues

ERROR: lib/ansible/modules/web_infrastructure/django_manage.py:0:0: E317 "app_path" is marked as required but specifies a default. Arguments with a default should not be marked as required
ERROR: lib/ansible/modules/web_infrastructure/django_manage.py:0:0: E317 "command" is marked as required but specifies a default. Arguments with a default should not be marked as required
ERROR: lib/ansible/modules/web_infrastructure/django_manage.py:0:0: E322 "clear" is listed in the argument_spec, but not documented in the module
ERROR: lib/ansible/modules/web_infrastructure/django_manage.py:0:0: E322 "fail_fast" is listed in the argument_spec, but not documented in the module
ERROR: lib/ansible/modules/web_infrastructure/django_manage.py:0:0: E322 "live_server" is listed in the argument_spec, but not documented in the module
ERROR: lib/ansible/modules/web_infrastructure/django_manage.py:0:0: E322 "liveserver" is listed in the argument_spec, but not documented in the module
ERROR: lib/ansible/modules/web_infrastructure/django_manage.py:0:0: E322 "python_path" is listed in the argument_spec, but not documented in the module
ERROR: lib/ansible/modules/web_infrastructure/django_manage.py:0:0: E322 "test_runner" is listed in the argument_spec, but not documented in the module
ERROR: lib/ansible/modules/web_infrastructure/django_manage.py:0:0: E322 "testrunner" is listed in the argument_spec, but not documented in the module
ERROR: lib/ansible/modules/web_infrastructure/django_manage.py:0:0: E322 "virtual_env" is listed in the argument_spec, but not documented in the module
ERROR: lib/ansible/modules/web_infrastructure/django_manage.py:0:0: E325 argument_spec for "clear" defines type="bool" but documentation does not
ERROR: lib/ansible/modules/web_infrastructure/django_manage.py:0:0: E325 argument_spec for "link" defines type="bool" but documentation does not
ERROR: lib/ansible/modules/web_infrastructure/django_manage.py:0:0: E325 argument_spec for "merge" defines type="bool" but documentation does not
ERROR: lib/ansible/modules/web_infrastructure/django_manage.py:0:0: E325 argument_spec for "skip" defines type="bool" but documentation does not
ERROR: lib/ansible/modules/web_infrastructure/django_manage.py:0:0: E326 Value for "choices" from the argument_spec ([]) for "command" does not match the documentation (['cleanup', 'collectstatic', 'flush', 'loaddata', 'migrate', 'runfcgi', 'syncdb', 'test', 'validate'])

In the same PR remove the offending lines from test/sanity/validate-modules/ignore.txt, which CI will tell you about.