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

Deprecate role_name in meta/main.yml #1042

Closed
chouseknecht opened this issue Aug 8, 2018 · 11 comments
Closed

Deprecate role_name in meta/main.yml #1042

chouseknecht opened this issue Aug 8, 2018 · 11 comments

Comments

@chouseknecht
Copy link
Contributor

chouseknecht commented Aug 8, 2018

During the Galaxy CLI Developer Workflow meeting we decided that Galaxy and Mazer should no longer synthesize the role (or repository) name, and therefore role_name needs to be deprecated.

For reference see: https://docs.google.com/document/d/1nx65quXCyYORNel72rRCovyQo_qO5fhHlqrnKyYNlYU/edit?usp=sharing

To let users know about this change, we need to start issuing a deprecation warning in the import output whenever role_name is found in meta/main.yml.

@chouseknecht
Copy link
Contributor Author

Back port this to 3.0.

@chouseknecht
Copy link
Contributor Author

See corresponding Mazer issue #115

@chouseknecht chouseknecht modified the milestones: 3.1 Sprint 2, 3.1.0 Aug 9, 2018
@joshbenner
Copy link

Will there be any way to have the Galaxy-hosted role name be different than the GitHub-hosted repo name?

@chouseknecht
Copy link
Contributor Author

Marking as blocked, until we re-confirm this change with @tima and the product team.

@brtkwr
Copy link

brtkwr commented Sep 3, 2018

Deprecating role_name is a terrible idea considering the fact that this is what people started doing to give their role the name they actually wanted rather than ansible_role_blah_blah... given than the regex to remove the ansible_role part was removed quite recently.... this is going to be another costly blow and major annoyance to many users who have just reconfigured their pipelines.

Also, why did you remove the hyphens? Only noticed this change today and this seems like another, quite frankly, poorly justified change that adds little benefit.

@oneswig
Copy link

oneswig commented Sep 3, 2018

A datapoint for your consideration:

As users of Galaxy our setup is broken by this proposal. The repos that back our Galaxy roles are in some cases widely used, forked and cloned. They all use the implicit naming convention of an ansible-role- prefix.

We have just been hit by having all our roles unexpectedly renamed to use underscores. What do you suggest users like us (and users of our roles) should do to maintain consistent developer and user experiences?

@trombik
Copy link

trombik commented Oct 8, 2018

we were told that "use web interface to change role name". then, "use role_name". and now role_name is deprecated.

the underscore change broke my deployments. role_name that i am trying to incorporate into all the roles has been deprecated. and now this: the reference mentioned in the issue says "You need permission". life is not easy, is it?

@trombik
Copy link

trombik commented Oct 13, 2018

@chouseknecht i appreciate your efforts to work on the issue. but i think a clear statement from the project should be given to users. Role Names in "Creating Role" does not say role_name is now deprecated. yet you made a comment in this issue that "Marking as blocked, until we re-confirm this change with @tima and the product team" on Aug 8. after months, no report on the re-confirmation. in #1128, @oneswig proposed a smoother transition, which was tagged as type/proposal. no comments has been given from the project team. i guess that the decision came not from you, probably it is a decision from higher layer and you might not be able to change it. that's fine. it happens a lot in corporate environments. but if the decision has been made and will not change, tell us so.

seriously, the galaxy project team needs to learn how to communicate with users from ansible project. i rarely read release notes from ansible project (sorry, my bad) unless my CI processes reports errors because ansible always tell us that something will be deprecated in version $X.$Y. ansible module documentations even says "this module is not yet stable", or "this module is stable enough and you may expect it will not break". I am quite faithful to ansible project.

@trombik
Copy link

trombik commented Oct 16, 2018

for those of you who decided to rename repository name to ansible-role-foo_bar because the change has already broken your CI, deployments, or whatever, here is another fun fact: you still need role_name in meta/main.yml because, without it, your role will be renamed to ansible_role_foo_bar, not foo_bar.

@chouseknecht chouseknecht modified the milestones: 3.1.0, 3.2.0 Nov 15, 2018
@geerlingguy
Copy link
Contributor

Yeah... just now noticed this issue, but I've spent waaaaay too much time this year managing role names with the UI changes (used to be able to adjust in Galaxy UI, then needed to manage via field in meta/main.yml, now not sure what will be used), the annoying - to _ then later back to - (and now forced _ migration, etc.

These kinds of changes may seem a bit trivial in isolation, but I think I've spent more time for some of my simpler roles just managing all the changes to Galaxy (and soon Mazer) than on maintaining the roles themselves.

@chouseknecht
Copy link
Contributor Author

Based on more recent conversations, role_name will not be deprecated for traditional roles. However, it will not be supported in the new Collection type.

bittner added a commit to painless-software/ansible-role-software that referenced this issue Feb 4, 2019
MyNameIsCosmo added a commit to HXR/ansible-role-ros-install that referenced this issue Mar 2, 2019
MyNameIsCosmo added a commit to HXR/ansible-role-ros-install that referenced this issue Mar 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants