mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 11:51:26 -07:00
a23c95023b
Enforce module deprecation.
After module has reached the end of it's deprecation cycle we will replace it with a docs stub.
* Replace deprecated modules with docs-only sub
* Use of deprecated past deprecation cycle gives meaningful message (see examples below)
* Enforce documentation.deprecation dict via `schema.py`
* Update `ansible-doc` and web docs to display documentation.deprecation
* Document that structure in `dev_guide`
* Ensure that all modules starting with `_` have a `deprecation:` block
* Ensure `deprecation:` block is only used on modules that start with `_`
* `removed_in` A string which represents when this module needs **deleting**
* CHANGELOG.md and porting_guide_2.5.rst list removed modules as well as alternatives
* CHANGELOG.md links to porting guide index
To ensure that meaningful messages are given to the user if they try to use a module at the end of it's deprecation cycle we enforce the module to contain:
```python
if __name__ == '__main__':
removed_module()
```
98 lines
3 KiB
Python
98 lines
3 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# (c) 2014, Matt Martz <matt@sivel.net>, and others
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
# this is a windows documentation stub. actual code lives in the .ps1
|
|
# file of the same name
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|
'status': ['deprecated'],
|
|
'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: true
|
|
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.
|
|
removes:
|
|
description:
|
|
- Path to a file removed by uninstalling the MSI to prevent from
|
|
attempting to re-uninstall the package on every run.
|
|
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
|
|
|
|
- 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
|
|
'''
|