Stub out modules scheduled for 2.8 removal (#44985)

* Remove modules scheduled for 2.8

* Add changelog and porting guide

* Skip docs test on removed modules

* Don't link to removed modules
This commit is contained in:
Matt Martz 2018-08-31 16:27:32 -05:00 committed by GitHub
commit f89d873698
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 98 additions and 1485 deletions

View file

@ -8,80 +8,12 @@
# file of the same name
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['deprecated'],
'status': ['removed'],
'supported_by': 'community'}
DOCUMENTATION = r'''
---
module: win_msi
version_added: '1.7'
deprecated:
removed_in: "2.8"
why: The win_msi module has a number of issues, the M(win_package) module is easier to maintain and use.
alternative: Use M(win_package) instead.
short_description: Installs and uninstalls Windows MSI files
description:
- Installs or uninstalls a Windows MSI file that is already located on the
target server.
options:
path:
description:
- File system path to the MSI file to install.
required: yes
type: path
extra_args:
description:
- Additional arguments to pass to the msiexec.exe command.
state:
description:
- Whether the MSI file should be installed or uninstalled.
choices: [ absent, present ]
default: present
creates:
description:
- Path to a file created by installing the MSI to prevent from
attempting to reinstall the package on every run.
type: path
removes:
description:
- Path to a file removed by uninstalling the MSI to prevent from
attempting to re-uninstall the package on every run.
type: path
version_added: '2.4'
wait:
description:
- Specify whether to wait for install or uninstall to complete before continuing.
type: bool
default: 'no'
version_added: '2.1'
notes:
- This module is not idempotent and will report a change every time.
Use the C(creates) and C(removes) options to your advantage.
- Please look into M(win_package) instead, this package will be deprecated in the future.
author:
- Matt Martz (@sivel)
'''
EXAMPLES = r'''
- name: Install an MSI file
win_msi:
path: C:\7z920-x64.msi
from ansible.module_utils.common.removed import removed_module
- name: Install an MSI, and wait for it to complete before continuing
win_msi:
path: C:\7z920-x64.msi
wait: yes
- name: Uninstall an MSI file
win_msi:
path: C:\7z920-x64.msi
state: absent
'''
RETURN = r'''
log:
description: The logged output from the installer
returned: always
type: string
sample: N/A
'''
if __name__ == '__main__':
removed_module(removed_in='2.8')