Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document get_url module check_mode support right #76433

Merged
merged 6 commits into from Dec 14, 2021
Merged

Document get_url module check_mode support right #76433

merged 6 commits into from Dec 14, 2021

Conversation

bluikko
Copy link
Contributor

@bluikko bluikko commented Dec 2, 2021 •
edited

SUMMARY

The get_url module does not really support check_mode as pointed out in #65687.
This is a simple PR to update the documentation to correctly say that check_mode is supported but the changed status will reflect comparison to an empty source file.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

get_url

ADDITIONAL INFORMATION

@ansibot ansibot added affects_2.13 core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. docs_only All changes are to files within the docs/docsite/ directory module This issue/PR relates to a module. needs_triage Needs a first human triage before being processed. small_patch support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Dec 2, 2021
@bluikko
Copy link
Contributor Author

bluikko commented Dec 2, 2021 •
edited

@jpmens I hope I got this right - does the "Docs Pull Request" refer to separate documentation or does it also include the inline documentation for modules (as in this case)? And I think the change type should be known_issues?

@ansibot
Copy link
Contributor

ansibot commented Dec 2, 2021

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

changelogs/fragments/76433-get_url-document-check_mode:0:0: extension must be one of: .yml, .yaml

click here for bot help

@ansibot ansibot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed core_review In order to be merged, this PR must follow the core review workflow. docs_only All changes are to files within the docs/docsite/ directory small_patch labels Dec 2, 2021
@jpmens
Copy link
Contributor

jpmens commented Dec 2, 2021

@bluikko to be honest, I don't know. I should, but I don't.

@jpmens
Copy link
Contributor

jpmens commented Dec 2, 2021

shipit

@bluikko
Copy link
Contributor Author

bluikko commented Dec 2, 2021 •
edited

The patch also removes supports_check_mode=True from argspec. I guess it is debatable if that should stay in.

Edit: I have put supports_check_mode=True back in to keep the scope of this PR strictly in documentation. I assume the CI should also then succeed.

@bluikko
Add supports_check_mode back to get_url argspec
d2a9b37 
Let's try to update only the documentation block and CI should succeed.
@ansibot ansibot added core_review In order to be merged, this PR must follow the core review workflow. and removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Dec 2, 2021
@jpmens
Copy link
Contributor

jpmens commented Dec 2, 2021

shipit

@nitzmahone nitzmahone removed the needs_triage Needs a first human triage before being processed. label Dec 2, 2021
@bluikko
Copy link
Contributor Author

bluikko commented Dec 3, 2021

This should be the final version, now the attributes block will document "partial" support with details describing it.

@samccann samccann merged commit f9c24c2 into ansible:devel Dec 14, 2021
@samccann
Copy link
Contributor

Thanks @bluikko for the Ansible docs fix and @jpmens for the tech review!

bcoca pushed a commit to bcoca/ansible that referenced this pull request Dec 15, 2021
@bluikko @bcoca
Document get_url module check_mode support right (ansible#76433)
4d0375e
@ansible ansible locked and limited conversation to collaborators Dec 28, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@samccann samccann samccann approved these changes

Assignees
No one assigned
Labels
affects_2.13 core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. module This issue/PR relates to a module. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@bluikko @ansibot @jpmens @samccann @nitzmahone