Skip to content

WIP 2.19 Porting Guide stub with data tagging #2429

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.

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

Open
wants to merge 12 commits into
base: devel
Choose a base branch
from

Conversation

nitzmahone
Copy link
Member

@nitzmahone nitzmahone commented Mar 3, 2025

We're linking to this PR as temporary documentation for the pending Data Tagging changes to core.

This PR won't include any other 2.19-specific Porting Guide entries.

@ansible-documentation-bot ansible-documentation-bot bot added the new_contributor This PR is the first contribution by a new community member. label Mar 3, 2025
@ansible-documentation-bot
Copy link
Contributor

Thanks for your Ansible docs contribution! We talk about Ansible documentation on Matrix at #docs:ansible.im if you ever want to join us and chat about the docs! We meet on Matrix every Tuesday. See the Ansible calendar for meeting details. We welcome additions to our weekly agenda items too. You can add the dawgs-meeting tag to a forum topic to bring it up at the next meeting.

@ansible-documentation-bot
Copy link
Contributor

Thanks for your contribution, @nitzmahone! Please make sure that your pull request includes sufficient and meaningful details in the description.
PR descriptions provide important context and allow other developers and our future selves to understand a change's rationale and what it actually fixes or accomplishes.

@ssbarnea
Copy link
Member

@nitzmahone I managed to get very close with linter changes (only 10 test failures) but I spotted an unexpected exception when I call:

ModuleArgsParser(sanitized_task).parse( skip_action_validation=True) 

With 2.18 code, my call succeeds but with this PR it raises:

"Complex args containing variables cannot use bare variables (without Jinja2 delimiters), and must use the full variable style ('{{var_name}}')"

My task looks like:

{'name': 'Ansible-lint for args rule should succeed (Bug - 3199)', 'vars': {'copy_vars': {'src': 'args.json'}}, 'action': 'ansible.builtin.copy', 'args': '{{ copy_vars }}'}

I am not sure how to make it pass with 2.19.

@gotmax23
Copy link
Collaborator

Thanks for working on this. What's the current status with this PR? The Steering Committee would like to notify collection maintainers about this change, but it'd be nice to link to official docs instead of a draft PR.

Copy link
Collaborator

@gotmax23 gotmax23 left a comment

Choose a reason for hiding this comment

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

The text is clear and informative. I left some style nits.

@@ -5,24 +5,546 @@
Ansible-core 2.19 Porting Guide
*******************************

This section discusses the behavioral changes between ``ansible-core`` 2.18 and ``ansible-core`` 2.19.
This section discusses the behavioral changes between ansible-core 2.18 and ansible-core 2.19.
Copy link
Collaborator

Choose a reason for hiding this comment

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

In https://docs.ansible.com/ansible/latest/dev_guide/style_guide/preferred_terms.html#preferred-terminology, I think either Ansible Core or ansible-core is preferred, but @samccann can probably clarify.

Comment on lines 527 to 529
Plugins that create new string instances with embedded templates must use the new ``trust_value`` function from
``ansible.module_utils.datatag`` to tag those values as originating from a trusted source to allow the templates to be
rendered.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should trust_value() have an example or further documentation, or are you waiting until the public API is more complete/stable?

Copy link
Member Author

Choose a reason for hiding this comment

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

We're still working out where the actual docs for those things will live- none of the current options are great 😐

* misc reorder, wordsmith
* address review feedback
@nitzmahone nitzmahone marked this pull request as ready for review April 16, 2025 00:20
@nitzmahone
Copy link
Member Author

@samccann Since core 2.19.0b1 is already out there, we should probably get this one merged and published pretty soon- still an open question on the quoting of ansible-core, and of course any other feedback you've got is welcome- thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new_contributor This PR is the first contribution by a new community member.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants