Adjust 'report this' messages to only report if the latest version still has this problem. (#1173)

This commit is contained in:
Felix Fontein 2025-10-16 17:41:11 +02:00 committed by GitHub
parent 3ff2cfe615
commit 6b5d76bdee
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 14 additions and 7 deletions

View File

@ -343,7 +343,8 @@ def _warn_missing_dry_run_prefix(line, warn_missing_dry_run_prefix, warn_functio
# This could be a bug, a change of docker compose's output format, ...
# Tell the user to report it to us :-)
warn_function(
f"Event line is missing dry-run mode marker: {line!r}. Please report this at "
f"Event line is missing dry-run mode marker: {line!r}. Please check with the latest community.docker version,"
" and if the problem still happens there, please report this at "
"https://github.com/ansible-collections/community.docker/issues/new?assignees=&labels=&projects=&template=bug_report.md"
)
@ -353,7 +354,8 @@ def _warn_unparsable_line(line, warn_function):
# Tell the user to report it to us :-)
if warn_function:
warn_function(
f"Cannot parse event from line: {line!r}. Please report this at "
f"Cannot parse event from line: {line!r}. Please check with the latest community.docker version,"
" and if the problem still happens there, please report this at "
"https://github.com/ansible-collections/community.docker/issues/new?assignees=&labels=&projects=&template=bug_report.md"
)
@ -400,7 +402,8 @@ def parse_json_events(stderr, warn_function=None):
continue
if warn_function:
warn_function(
f"Cannot parse event from non-JSON line: {line!r}. Please report this at "
f"Cannot parse event from non-JSON line: {line!r}. Please check with the latest community.docker version,"
" and if the problem still happens there, please report this at "
"https://github.com/ansible-collections/community.docker/issues/new?assignees=&labels=&projects=&template=bug_report.md"
)
continue
@ -409,7 +412,8 @@ def parse_json_events(stderr, warn_function=None):
except Exception as exc: # pylint: disable=broad-exception-caught
if warn_function:
warn_function(
f"Cannot parse event from line: {line!r}: {exc}. Please report this at "
f"Cannot parse event from line: {line!r}: {exc}. Please check with the latest community.docker version,"
" and if the problem still happens there, please report this at "
"https://github.com/ansible-collections/community.docker/issues/new?assignees=&labels=&projects=&template=bug_report.md"
)
continue
@ -477,7 +481,8 @@ def parse_json_events(stderr, warn_function=None):
except KeyError:
if warn_function:
warn_function(
f"Unknown resource type {resource_type_str!r} in line {line!r}. Please report this at "
f"Unknown resource type {resource_type_str!r} in line {line!r}. Please check with the latest community.docker version,"
" and if the problem still happens there, please report this at "
"https://github.com/ansible-collections/community.docker/issues/new?assignees=&labels=&projects=&template=bug_report.md"
)
resource_type = ResourceType.UNKNOWN

View File

@ -15,6 +15,7 @@ version_added: 1.1.0
description:
- Return facts about whether the module runs in a Docker or podman container.
- This module attempts a best-effort detection. There might be special cases where it does not work; if you encounter one,
make sure that this is still a problem with the latest community.docker release, and if it is,
L(please file an issue, https://github.com/ansible-collections/community.docker/issues/new?assignees=&labels=&template=bug_report.md).
author:
- Felix Fontein (@felixfontein)

View File

@ -809,8 +809,9 @@ options:
description:
- Platform for the container in the format C(os[/arch[/variant]]).
- "Note that since community.docker 3.5.0, the module uses both the image's metadata and the Docker daemon's information
to normalize platform strings similarly to how Docker itself is doing this. If you notice idempotency problems, L(please
create an issue in the community.docker GitHub repository,
to normalize platform strings similarly to how Docker itself is doing this. If you notice idempotency problems, please
verify whether this is still a problem with the latest release of community.docker, and if it is,
L(create an issue in the community.docker GitHub repository,
https://github.com/ansible-collections/community.docker/issues/new?assignees=&labels=&projects=&template=bug_report.md).
For older community.docker versions, you can use the O(comparisons) option with C(platform: ignore) to prevent accidental
recreation of the container due to this."