Mojo

Contrary to documentation requiredRoles are not always valid

Details

  • Complexity:
    Intermediate
  • Number of attachments :
    0

Description

While the project's site states that "requiredRoles are always valid" this is not the case. Please either fix the documentation or the behavior of the requireDeveloperRoles and requireContributorRoles rules.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Baptiste Mathus added a comment -

Hi Andreas,
Could you give a bit more details on the cases where it fails for you?
Thanks

Show
Baptiste Mathus added a comment - Hi Andreas, Could you give a bit more details on the cases where it fails for you? Thanks
Hide
Permalink
Andreas Sewe added a comment -

OK, reconstructing my thoughts from back then: The "problem" is exemplified in <https://bitbucket.org/scalabench/scalabench-parent/src/974afdcefaa61af1a8dc9cd7b83eeaae8b3aea5a/pom.xml?at=1-SNAPSHOT#cl-401>; I did need to specify the "Project Founder" role twice, once in requireRoles and once in validRoles. From the "requiredRoles are always valid" piece of documentation I would assume that this repetition was unnecessary, as a required role must be valid in order to be useful. (FWIW, requiredRoles and optionalRoles would be better names for this interpretation.)

Hope this clarifies things.

Show
Andreas Sewe added a comment - OK, reconstructing my thoughts from back then: The "problem" is exemplified in < https://bitbucket.org/scalabench/scalabench-parent/src/974afdcefaa61af1a8dc9cd7b83eeaae8b3aea5a/pom.xml?at=1-SNAPSHOT#cl-401 >; I did need to specify the "Project Founder" role twice, once in requireRoles and once in validRoles . From the "requiredRoles are always valid" piece of documentation I would assume that this repetition was unnecessary, as a required role must be valid in order to be useful. (FWIW, requiredRoles and optionalRoles would be better names for this interpretation.) Hope this clarifies things.
Hide
Permalink
Baptiste Mathus added a comment -

OK, now I got it. And it seems to me this is a bug since the documentation is explicitly giving an wrong example that won't work is you use the requiredRole "lead engineer" which is not restated in the validRoles part (see http://mojo.codehaus.org/extra-enforcer-rules/requireDeveloperRoles.html)

I've created an IT that fails locally. So the bug is already half fixed .

More to come.

Show
Baptiste Mathus added a comment - OK, now I got it. And it seems to me this is a bug since the documentation is explicitly giving an wrong example that won't work is you use the requiredRole "lead engineer" which is not restated in the validRoles part (see http://mojo.codehaus.org/extra-enforcer-rules/requireDeveloperRoles.html ) I've created an IT that fails locally. So the bug is already half fixed . More to come.
Hide
Permalink
Baptiste Mathus added a comment -

Fixed in revision 18007.

Show
Baptiste Mathus added a comment - Fixed in revision 18007 .
Hide
Permalink
Mirko Friedenhagen added a comment - - edited

Hopefully with https://fisheye.codehaus.org/changelog/mojo?cs=18014 and the test at https://fisheye.codehaus.org/browse/mojo/trunk/mojo/extra-enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/RequireRolesTest.java?r=18016 the intention is better understandable .

Show
Mirko Friedenhagen added a comment - - edited Hopefully with https://fisheye.codehaus.org/changelog/mojo?cs=18014 and the test at https://fisheye.codehaus.org/browse/mojo/trunk/mojo/extra-enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/RequireRolesTest.java?r=18016 the intention is better understandable .

People

  • Assignee:
    Baptiste Mathus
    Reporter:
    Andreas Sewe
Vote (0)
Watch (3)

Dates

  • Created:
    Updated:
    Resolved: