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

name[casing]: All tasks should be named and start with a capital letter #2169

Closed
cidrblock opened this issue May 23, 2022 · 3 comments · Fixed by #2274
Closed

name[casing]: All tasks should be named and start with a capital letter #2169

cidrblock opened this issue May 23, 2022 · 3 comments · Fixed by #2274
Assignees
@ssbarnea
Labels
new rule A request for a new rule

Comments

@cidrblock
Copy link
Contributor

Starting to pull in possible rule ideas from the community of practice: redhat-cop/automation-good-practices#64

The description of a task (the name key) should start with a capital letter, this will help with readability and help task files and playbook read more like documentation.
@cidrblock cidrblock added the new rule A request for a new rule label May 23, 2022
@cidrblock cidrblock mentioned this issue May 23, 2022
Closed
@ssbarnea ssbarnea changed the title Rule request: All tasks should be named and start with a capital letter name-capitalized: All tasks should be named and start with a capital letter Jul 19, 2022
@ssbarnea ssbarnea changed the title name-capitalized: All tasks should be named and start with a capital letter name-capital: All tasks should be named and start with a capital letter Jul 19, 2022
@ssbarnea ssbarnea mentioned this issue Aug 7, 2022
Merged
ssbarnea added a commit to ssbarnea/ansible-lint that referenced this issue Aug 7, 2022
@ssbarnea
Reimplement unamed-task rule as name[missing]
59164f8 
This reimplementation will allow us to implement closely related
extra checks.

Related: ansible#2171 ansible#2170 ansible#2169 ansible#2036
ssbarnea added a commit to ssbarnea/ansible-lint that referenced this issue Aug 9, 2022
@ssbarnea
Reimplement unamed-task rule as name[missing]
bb4ef5e 
This reimplementation will allow us to implement closely related
extra checks.

Related: ansible#2171 ansible#2170 ansible#2169 ansible#2036
ssbarnea added a commit to ssbarnea/ansible-lint that referenced this issue Aug 9, 2022
@ssbarnea
Reimplement unamed-task rule as name[missing]
ee1a8eb 
This reimplementation will allow us to implement closely related
extra checks.

Related: ansible#2171 ansible#2170 ansible#2169 ansible#2036
ssbarnea added a commit to ssbarnea/ansible-lint that referenced this issue Aug 9, 2022
@ssbarnea
Reimplement unamed-task rule as name[missing]
373d2a7 
This reimplementation will allow us to implement closely related
extra checks.

Related: ansible#2171 ansible#2170 ansible#2169 ansible#2036
ssbarnea added a commit that referenced this issue Aug 9, 2022
@ssbarnea
Reimplement unamed-task rule as name[missing] (#2263)
0810c24 
This reimplementation will allow us to implement closely related
extra checks.

Related: #2171 #2170 #2169 #2036
@ssbarnea ssbarnea self-assigned this Aug 9, 2022
ssbarnea added a commit to ssbarnea/ansible-lint that referenced this issue Aug 9, 2022
@ssbarnea
Add name[casing] to identify wrongly capitalized task names
153955a 
Fixes: ansible#2169
ssbarnea added a commit to ssbarnea/ansible-lint that referenced this issue Aug 9, 2022
@ssbarnea
Add name[casing] to identify wrongly capitalized task names
f65c037 
Fixes: ansible#2169
@ssbarnea ssbarnea mentioned this issue Aug 9, 2022
Merged
ssbarnea added a commit to ssbarnea/ansible-lint that referenced this issue Aug 9, 2022
@ssbarnea
Add name[casing] to identify wrongly capitalized task names
86dc4e9 
Fixes: ansible#2169
ssbarnea added a commit to ssbarnea/ansible-lint that referenced this issue Aug 9, 2022
@ssbarnea
Add name[casing] to identify wrongly capitalized task names
f80d219 
Fixes: ansible#2169
ssbarnea added a commit that referenced this issue Aug 9, 2022
@ssbarnea
Add name[casing] to identify wrongly capitalized task names (#2274)
720f0f7 
Fixes: #2169
@ktdreyer
Copy link

ktdreyer commented Sep 2, 2022

Anyone have a good sed command that will globally fix this problem? It would be great to add this to the ansible-lint docs.

@ssbarnea
Copy link
Member

ssbarnea commented Sep 2, 2022

@cognifloyd ^ that might be a good opportunity to add rewrite for this one.

I used code (vscode) search and replace in files with regex to fix them.

@ssbarnea ssbarnea changed the title name-capital: All tasks should be named and start with a capital letter name[casing]: All tasks should be named and start with a capital letter Sep 24, 2022
@gpettey
Copy link

gpettey commented Jun 26, 2023 •
edited

Just started using the linter, and expressing strong disagreement with this rule while I'm having trouble disabling it in .ansiblelint. Capital letters are for complete sentences, not for single-word task labels. I'm writing in English, not German.

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

@ssbarnea ssbarnea

Labels
new rule A request for a new rule
Projects
ansible-lint --fix
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add name[casing] to identify wrongly capitalized task names ssbarnea/ansible-lint
4 participants
@ssbarnea @ktdreyer @cidrblock @gpettey