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.

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

Role Declaration section deprecation #4

Closed
waded opened this issue Aug 14, 2018 · 6 comments
Closed

Role Declaration section deprecation #4

waded opened this issue Aug 14, 2018 · 6 comments

Comments

@waded
Copy link
Contributor

waded commented Aug 14, 2018

In practice I find the current "Role Declaration" rule (create a task file named to match the role, then include that file in a main.yml that does nothing else) to be boilerplate-heavy, forcing an include right off the bat to address what's generally an editor issue ("having several main.yml files open at once can get very confusing".) It also encourages a single task file per role, which in larger roles may not be the right structure... as to name a task file otherwise contradicts the role name, so it seems people generally just append more and more to the task file.

I prefer we don't favor boilerplate to fix editor issues in favor of purposeful use of multiple files, so I recommend we strike "Role Declation" in favor of well-documented main.yml, then fragmenting into multiple task .yml files as needed, none of them named the same as the role itself.

@elloboblanco
Copy link
Contributor

Seems reasonable to me, :shipit:

@waded
Copy link
Contributor Author

waded commented Aug 15, 2018

@S3v3nL34fKl0v3r , @warren1011 ?

@wsutherland-relias
Copy link

This sounds like a good idea to me.

@brikr
Copy link
Contributor

brikr commented Aug 20, 2018

This convention was originally proposed by @blakedietz. Maybe he can weigh in on this? I'm okay with the change.

@blakedietz
Copy link
Contributor

I think that this change makes sense @waded. You hit the nail on the head as far as

I prefer we don't favor boilerplate to fix editor issues in favor of purposeful use of multiple files, so I recommend we strike "Role Declation" in favor of well-documented main.yml, then fragmenting into multiple task .yml files as needed, none of them named the same as the role itself.

@waded
Copy link
Contributor Author

waded commented Aug 21, 2018

Thanks for taking the time to give feedback on this. We'll go with it.

@waded waded closed this as completed in 8fb3859 Aug 21, 2018
waded added a commit that referenced this issue Aug 21, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

5 participants