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

ansible-doc - output additional version_added information from main/argument_specs.yml #80625

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from
Open

ansible-doc - output additional version_added information from main/argument_specs.yml #80625

wants to merge 1 commit into from
+9 −0

Conversation

ziegenberg
Copy link
Contributor

SUMMARY

The command ansible-doc -t role -l did not output the version_added from the role argument specification information at the entrypoint level, but antsibull-docs has been supporting it since role support was added. The behavior between the two tools is now aligned.

Relates to: #79994

ISSUE TYPE
  • Feature Pull Request
COMPONENT NAME
  • ansible-doc
ADDITIONAL INFORMATION

n/a

felixfontein
felixfontein reviewed Apr 25, 2023
View reviewed changes
Copy link
Contributor

@felixfontein felixfontein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Besides this, LGTM!

changelogs/fragments/docs_argument_specs_version_added.yml Outdated Show resolved Hide resolved
@ziegenberg ziegenberg mentioned this pull request Apr 25, 2023
Closed
@ansibot ansibot added affects_2.16 feature This issue/PR relates to a feature request. needs_triage Needs a first human triage before being processed. labels Apr 25, 2023
@ziegenberg
docs - output additional version_added information from main/argument…
0b161c6 
…_specs.yml

The command `ansible-doc -t role -l` did not output the `version_added`
from the role argument specification information at the entrypoint
level, but antsibull-docs has been supporting it since role support was
added. The behavior between the two tools is now aligned.

Signed-off-by: Daniel Ziegenberg <daniel@ziegenberg.at>
@ziegenberg ziegenberg force-pushed the add-version_added-for-entrypoints-in-main-argument_specs.yml branch from ed7cebc to 0b161c6 Compare April 25, 2023 11:17
@bcoca
Copy link
Member

bcoca commented Apr 25, 2023

normally ansible-doc left out 'version added' because you knew it affects the 'current version you are using' while the html/other docs can be for different versions and require more information.

@mkrizek mkrizek removed the needs_triage Needs a first human triage before being processed. label Apr 25, 2023
@felixfontein
Copy link
Contributor

@bcoca for plugins/modules in collections it (almost) always prints that information:

$ ansible-doc community.crypto.crypto_info
> COMMUNITY.CRYPTO.CRYPTO_INFO    (/path/to/ansible_collections/community/crypto/plugins/modules/crypto_info.py)

        Retrieve information on cryptographic capabilities. The current version retrieves information on the Python cryptography library
        <https://cryptography.io/> available to Ansible modules, and on the OpenSSL binary `openssl' found in the path.

ADDED IN: version 2.1.0 of community.crypto

ATTRIBUTES:
[...]

Also for builtin modules that information is printed (for example for 'ansible.builtin.copy': ADDED IN: historical).

@bcoca
Copy link
Member

bcoca commented Apr 25, 2023 •
edited
Loading

I have PR to remove that (which was 'recentish' addition), we had not meant for the console display to have that info normally

@felixfontein
Copy link
Contributor

It would be great if that information could be kept. There are a lot of roles, modules, plugins, and collections that do not have HTML docs or other docs where this information can be seen. Having to look at ansible-doc --json or at the sources isn't really user-friendly.

@bcoca
Copy link
Member

bcoca commented Apr 25, 2023

that and other info is behind -v (in my PR, not merged/live yet)

@ansibot ansibot added the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label May 3, 2023
@ziegenberg
Copy link
Contributor Author

@felixfontein any news on this PR? Can this move forward?

@felixfontein
Copy link
Contributor

@ziegenberg IMO it would already have been merged. You need to ask the core team, not me...

@felixfontein
Copy link
Contributor

#78730 is in a similar boat...

@ansibot ansibot added the needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html label Jan 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@felixfontein felixfontein felixfontein left review comments

Assignees
No one assigned
Labels
affects_2.16 feature This issue/PR relates to a feature request. needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@ziegenberg @bcoca @felixfontein @mkrizek @ansibot