a-c-m
/
community.general
mirror of https://github.com/ansible-collections/community.general.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

slack: deprecate current default `auto` for `prepend_hash` (#9443) 

Thanks @felixfontein !
pull/9447/head
Felix Fontein 2024-12-29 00:19:40 +01:00 committed by GitHub
parent 2203560867
commit c83fc5fd49
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
changelogs/fragments/9443-slack-prepend_hash.yml Normal file
View File

@ -0,0 +1,3 @@
deprecated_features:
- "slack - the default value ``auto`` of the ``prepend_hash`` option is deprecated and will change to ``never`` in community.general 12.0.0
(https://github.com/ansible-collections/community.general/pull/9443)."

16
plugins/modules/slack.py
View File

@ -134,11 +134,14 @@ options:
a small set of the prefixes that should not have a V(#) prepended. Since an exact condition which O(channel) values must not have the a small set of the prefixes that should not have a V(#) prepended. Since an exact condition which O(channel) values must not have the
V(#) prefix is not known, the value V(auto) for this option will be deprecated in the future. It is best to explicitly set O(prepend_hash=always) V(#) prefix is not known, the value V(auto) for this option will be deprecated in the future. It is best to explicitly set O(prepend_hash=always)
or O(prepend_hash=never) to obtain the needed behavior. or O(prepend_hash=never) to obtain the needed behavior.
- The B(current default) is V(auto), which has been B(deprecated) since community.general 10.2.0.
It will change to V(never) in community.general 12.0.0.
To prevent deprecation warnings you can explicitly set O(prepend_hash) to the value you want.
We suggest to only use V(always) or V(never), but not V(auto), when explicitly setting a value.
choices: choices:
- 'always' - 'always'
- 'never' - 'never'
- 'auto' - 'auto'
default: 'auto'
version_added: 6.1.0 version_added: 6.1.0
""" """
@ -446,7 +449,7 @@ def main():
attachments=dict(type='list', elements='dict'), attachments=dict(type='list', elements='dict'),
blocks=dict(type='list', elements='dict'), blocks=dict(type='list', elements='dict'),
message_id=dict(type='str'), message_id=dict(type='str'),
prepend_hash=dict(type='str', default='auto', choices=['always', 'never', 'auto']), prepend_hash=dict(type='str', choices=['always', 'never', 'auto']),
), ),
supports_check_mode=True, supports_check_mode=True,
) )
@ -467,6 +470,15 @@ def main():
message_id = module.params['message_id'] message_id = module.params['message_id']
prepend_hash = module.params['prepend_hash'] prepend_hash = module.params['prepend_hash']
if prepend_hash is None:
module.deprecate(
"The default value 'auto' for 'prepend_hash' is deprecated and will change to 'never' in community.general 12.0.0."
" You can explicitly set 'prepend_hash' in your task to avoid this deprecation warning",
version="12.0.0",
collection_name="community.general",
)
prepend_hash = 'auto'
color_choices = ['normal', 'good', 'warning', 'danger'] color_choices = ['normal', 'good', 'warning', 'danger']
if color not in color_choices and not is_valid_hex_color(color): if color not in color_choices and not is_valid_hex_color(color):
module.fail_json(msg="Color value specified should be either one of %r " module.fail_json(msg="Color value specified should be either one of %r "