Skip to content

[Automated] Update ansible CLI Options - #3962

Open
thomhurst wants to merge 1 commit into
mainfrom
automated/update-cli-options-ansible
Open

[Automated] Update ansible CLI Options#3962
thomhurst wants to merge 1 commit into
mainfrom
automated/update-cli-options-ansible

Conversation

@thomhurst

@thomhurst thomhurst commented Aug 16, 2026

Copy link
Copy Markdown
Owner

Summary

This PR contains automatically generated updates to ansible CLI options classes.

The generator scraped the latest CLI help output from the installed tool.

Changes

  • Updated options classes to reflect latest CLI documentation
  • Added new commands if any were detected
  • Updated option types and descriptions

Command coverage

Command coverage report:

  • ansible (ansible [core 2.21.3] config file = None configured module search path = ['/home/runner/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules'] ansible python module location = /opt/pipx/venvs/ansible-core/lib/python3.12/site-packages/ansible ansible collection location = /home/runner/.ansible/collections:/usr/share/ansible/collections executable location = /opt/pipx_bin/ansible python version = 3.12.3 (main, Jun 19 2026, 12:46:00) [GCC 13.3.0] (/opt/pipx/venvs/ansible-core/): 1 commands, tree 0cb87f727f31e5f5a59cca8a10c8f9b55622be05305d4e7e92c334f5911e1034

Verification

  • Solution builds successfully
  • API compatibility gate: success

🤖 Generated with ModularPipelines.OptionsGenerator

Summary by CodeRabbit

  • Documentation
    • Clarified that the ansible executable must be installed separately and available on the system PATH.
    • Updated the module example to demonstrate listing hosts with the appropriate execution option.

@thomhurst thomhurst added automated dependencies Pull requests that update a dependency file labels Aug 16, 2026
@thomhurst
thomhurst enabled auto-merge (squash) August 16, 2026 02:35
@coderabbitai

coderabbitai Bot commented Aug 16, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 4517cd4f-7ddc-4ce3-8c82-5eda69161dcd

📥 Commits

Reviewing files that changed from the base of the PR and between 8a831c7 and f14dc22.

⛔ Files ignored due to path filters (4)
  • src/ModularPipelines.Ansible/Extensions/AnsibleExtensions.Generated.cs is excluded by !**/*.generated.*
  • src/ModularPipelines.Ansible/Generated/Ansible.CommandCoverage.json is excluded by !**/generated/**
  • src/ModularPipelines.Ansible/Options/AnsibleExecuteOptions.Generated.cs is excluded by !**/*.generated.*
  • src/ModularPipelines.Ansible/Services/IAnsible.Generated.cs is excluded by !**/*.generated.*
📒 Files selected for processing (1)
  • docs/docs/mp-packages/cli/ansible.md

Included review availability: Your plan includes up to 3 reviews per rolling hour; 1 remains after this review.


📝 Walkthrough

Walkthrough

The Ansible documentation now separates executable prerequisites from package installation and updates the example to enable host listing.

Changes

Ansible CLI documentation

Layer / File(s) Summary
Clarify Ansible setup and example
docs/docs/mp-packages/cli/ansible.md
The documentation states that ansible must be installed separately and available on PATH. The example sets ListHosts = true for localhost.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to f14dc

This localized generated update changes Ansible CLI option documentation and bindings without identified product or runtime impact; no actionable merge-blocking risk remains after the normal documentation build checks pass.

Poem

A rabbit reads the setup with care,
“Install Ansible separately,” says the hare.
The hosts now list in a tidy row,
With ListHosts set to true below.
Clear docs help the pipelines go!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the automated update to Ansible CLI options, which matches the main objective of the pull request.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch automated/update-cli-options-ansible

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: f14dc22193

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

/// Become password file
/// </summary>
[SecretValue]
[CliOption("--become-password-file")]

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Restore secret masking for Ansible password files

Whenever a caller sets BecomePasswordFile, ConnectionPasswordFile, or VaultPasswordFile, removing [SecretValue] prevents Command.RegisterSecrets from registering those values, so they are no longer obfuscated in command logs and errors. This also deterministically fails Credential_Options_Are_Marked_As_Secrets in test/ModularPipelines.Ansible.UnitTests/Attributes/AnsibleOptionsTests.cs, which explicitly requires all three annotations; preserve them through the generator or an override.

AGENTS.md reference: AGENTS.md:L158-L162

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automated dependencies Pull requests that update a dependency file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant