Skip to content

fix: correct partial-become rule documentation comments #4876

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

Merged
ssbarnea merged 1 commit into from
Jan 5, 2026
+4 −4
Merged

fix: correct partial-become rule documentation comments #4876

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/ansiblelint/rules/partial_become.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This rule can produce the following messages:

!!! warning

While Ansible inherits have of `become` and `become_user` from upper levels,
While Ansible inherits `become` and `become_user` from upper levels,
like play level or command line, we do not look at these values. This rule
requires you to be explicit and always define both in the same place, mainly
in order to prevent accidents when some tasks are moved from one location to
Expand All @@ -32,7 +32,7 @@ This rule can produce the following messages:
ansible.builtin.service:
name: httpd
state: started
become_user: apache # <- Does not change the user because "become: true" is not set.
become_user: apache # <- "become: true" should be set here, not at play level.
```

## Correct Code
Expand Down Expand Up @@ -88,7 +88,7 @@ This rule can produce the following messages:
ansible.builtin.service:
name: httpd
state: started
become_user: apache # <- Does not change the user because "become: true" is not set.
become_user: apache # <- "become: true" should be set here, not rely on play level.
```

## Correct Code
Expand Down Expand Up @@ -118,7 +118,7 @@ This rule can produce the following messages:
name: httpd
state: started
become: true # <- Activates privilege escalation.
become_user: apache # <- Does not change the user because "become: true" is not set.
become_user: apache # <- Changes the user with the desired privileges.
```

!!! note
Expand Down