Maven 2.x Enforcer Plugin

Incorrect documentation for writing a custom rule

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: 1.0-alpha-3
  • Fix Version/s: 1.0-beta-1
  • Component/s: Rule API
  • Labels:
    None
  • Number of attachments :
    0

Description

The documentation at http://maven.apache.org/enforcer/enforcer-api/writing-a-custom-rule.html has the wrong dependencies and code examples for creating a custom rule.

It defines 

<dependency>
  <groupId>org.apache.maven.enforcer</groupId>
  <artifactId>enforcer-api</artifactId>
  <version>${api.version}</version>
  </dependency>

instead of 

<dependency>
  <groupId>org.apache.maven.shared</groupId>
  <artifactId>maven-enforcer-rule-api</artifactId>
  <version>1.0-alpha-2</version>
</dependency>

and so the code examples are incorrect because:

  1. Incorrect imports:
    • The imports are for
      • org.apache.maven.enforcer.rule.api.EnforcerRule
      • org.apache.maven.enforcer.rule.api.EnforcerRuleException
      • org.apache.maven.enforcer.rule.api.EnforcerRuleHelper
    • instead of
      • org.apache.maven.shared.enforcer.rule.api.EnforcerRule
      • org.apache.maven.shared.enforcer.rule.api.EnforcerRuleException
      • org.apache.maven.shared.enforcer.rule.api.EnforcerRuleHelper.
    • Implementing import org.apache.maven.enforcer.rule.api.EnforcerRule causes the custom plugin invocation to fail with an ArrayStoreException as the expected type is import org.apache.maven.shared.enforcer.rule.api.EnforcerRule instead.
  2. It shows implementing public String getCacheId(), public boolean isCacheable(), public boolean isResultValid( EnforcerRule arg0 ) which are no longer needed.

Activity

Ascending order - Click to sort in descending order
Brian Fox made changes -
Field Original Value New Value
Fix Version/s 1.0 [ 13616 ]
Hide
Permalink
Nick Stolwijk added a comment -

The documentation on the site is for 1.0-SNAPSHOT, which has changed GroupId / ArtifactId from version 1.0-alpha-2 to the current SNAPSHOT. So for the current version (SNAPSHOT) the site is right, but for the current alpha release it is not right.

Also the method you've mentioned are necessary in current SNAPSHOT.

Show
Nick Stolwijk added a comment - The documentation on the site is for 1.0-SNAPSHOT, which has changed GroupId / ArtifactId from version 1.0-alpha-2 to the current SNAPSHOT. So for the current version (SNAPSHOT) the site is right, but for the current alpha release it is not right. Also the method you've mentioned are necessary in current SNAPSHOT.
Hide
Permalink
Brian Jackson added a comment -

Our builds started failing today because Maven updated to the latest enforcer release 1.0-alpha-4 and we have a custom rule. The error is an ArrayStoreException. Is the 1.0-alpha-4 finally matching the documentation and org.apache.maven.enforcer.rule.api.EnforcerRule is now the correct interface to implement? If true, that's a pretty significant change that wasn't documented in the release notes that is guaranteed to break builds for anyone using the enforcer plugin and not using an explicit version.

Also the release notes for 1.0-alpha-4 imply there is a noSnapshots standard rule but its not yet documented here: http://maven.apache.org/enforcer/enforcer-rules/index.html
I ask because my custom rule that broke with 1.0-alpha-4 duplicates this functionality and I'd rather just used the standard rule if its available now.

Show
Brian Jackson added a comment - Our builds started failing today because Maven updated to the latest enforcer release 1.0-alpha-4 and we have a custom rule. The error is an ArrayStoreException. Is the 1.0-alpha-4 finally matching the documentation and org.apache.maven.enforcer.rule.api.EnforcerRule is now the correct interface to implement? If true, that's a pretty significant change that wasn't documented in the release notes that is guaranteed to break builds for anyone using the enforcer plugin and not using an explicit version. Also the release notes for 1.0-alpha-4 imply there is a noSnapshots standard rule but its not yet documented here: http://maven.apache.org/enforcer/enforcer-rules/index.html I ask because my custom rule that broke with 1.0-alpha-4 duplicates this functionality and I'd rather just used the standard rule if its available now.
Hide
Permalink
Brian Fox added a comment -

Sorry about the api change, it was done >year ago and I just overlooked it. I don't anticipate the api changing at all, in fact this was originally scheduled to be 1.0, but i had some issues with the plugin rule that i want to redo first.

The noSnapshots rule was renamed and is doc'd, it's called requireReleaseDeps: http://maven.apache.org/enforcer/enforcer-rules/requireReleaseDeps.html

There is a "noSnapshots" rule, but it prints a deprecation warning and then calls the one above.

Show
Brian Fox added a comment - Sorry about the api change, it was done >year ago and I just overlooked it. I don't anticipate the api changing at all, in fact this was originally scheduled to be 1.0, but i had some issues with the plugin rule that i want to redo first. The noSnapshots rule was renamed and is doc'd, it's called requireReleaseDeps: http://maven.apache.org/enforcer/enforcer-rules/requireReleaseDeps.html There is a "noSnapshots" rule, but it prints a deprecation warning and then calls the one above.
Brian Fox made changes -
Fix Version/s 1.0-beta-1 [ 14948 ]
Fix Version/s 1.0 [ 13616 ]
Brian Fox made changes -
Resolution Fixed [ 1 ]
Status Open [ 1 ] Closed [ 6 ]

People

  • Assignee:
    Brian Fox
    Reporter:
    Ben Lidgey
Vote (0)
Watch (1)

Dates

  • Created:
    Updated:
    Resolved: