[MENFORCER-422] Added externalRules rule #180

gastaldi · 2022-08-11T17:09:55Z

Following this checklist to help us incorporate your
contribution quickly and easily:

Make sure there is a JIRA issue filed
for the change (usually before you start working on it). Trivial changes like typos do not
require a JIRA issue. Your pull request should address just this issue, without
pulling in other changes.
Each commit in the pull request should have a meaningful subject line and body.
Format the pull request title like [MENFORCER-XXX] - Fixes bug in ApproximateQuantiles,
where you replace MENFORCER-XXX with the appropriate JIRA issue. Best practice
is to use the JIRA issue title in the pull request title and in the first line of the
commit message.
Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
Run mvn clean verify to make sure basic checks pass. A more thorough check will
be performed on your pull request automatically.
You have run the integration tests successfully (mvn -Prun-its clean verify).

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

I hereby declare this contribution to be licenced under the Apache License Version 2.0, January 2004
In any other case, please file an Apache Individual Contributor License Agreement.

ppalaga

This would be great, thanks @gastaldi! Some comments inline.

Another important feature for the future: be able to customize the descriptor before processing, ideally through an XSLT. Motivation: some artifacts that are banned in Quarkus might be required in Camel Quarkus. With XSLT I could remove those specific ones from Quarkus descriptor and keep the rest.

maven-enforcer-plugin/src/it/projects/descriptors-local-always-pass/pom.xml

enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/Descriptors.java

gastaldi · 2022-08-11T20:15:18Z

Another important feature for the future: be able to customize the descriptor before processing, ideally through an XSLT. Motivation: some artifacts that are banned in Quarkus might be required in Camel Quarkus. With XSLT I could remove those specific ones from Quarkus descriptor and keep the rest.

@ppalaga because other transformation steps might be needed and because I wanted to keep it simple, I think this would be better served if the transformed file were already available as a separate dependency (eg. you could use the Maven dependency plugin to unpack the original rule XML, transform and include the transformed file in another dependency with another GAV), but we can discuss about that.

ppalaga · 2022-08-11T20:34:47Z

you could use the Maven dependency plugin to unpack the original rule XML, transform and include the transformed file in another dependency with another GAV), but we can discuss about that.

Yes, I know, but it is a sh** lot of XML that I hoped to be able to avoid :)

enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/ExternalRules.java

ppalaga

The code looks great!
I made one JavaDoc suggestion inline.
Otherwise, I wonder whether there is any Enforcer end user docs, where an externalRules example could be added?

gastaldi · 2022-08-15T14:08:40Z

Otherwise, I wonder whether there is any Enforcer end user docs, where an externalRules example could be added?

I added an example doc in the generated site

- Fixes quarkusio#24880 This moves the rules to an external rule file to allow reusing enforcer rules in another modules. For more information: https://github.com/gastaldi/enforcer-rules#externalrules PS: The ExternalRules rule is tracked in [MENFORCER-422](https://issues.apache.org/jira/browse/MENFORCER-422) will be migrated in the maven-enforcer-plugin upstream repository in this PR: - apache/maven-enforcer#180

- Fixes #24880 This moves the rules to an external rule file to allow reusing enforcer rules in another modules. For more information: https://github.com/gastaldi/enforcer-rules#externalrules PS: The ExternalRules rule is tracked in [MENFORCER-422](https://issues.apache.org/jira/browse/MENFORCER-422) will be migrated to the maven-enforcer-plugin upstream repository in this PR: - apache/maven-enforcer#180

- Fixes quarkusio#24880 This moves the rules to an external rule file to allow reusing enforcer rules in another modules. For more information: https://github.com/gastaldi/enforcer-rules#externalrules PS: The ExternalRules rule is tracked in [MENFORCER-422](https://issues.apache.org/jira/browse/MENFORCER-422) will be migrated to the maven-enforcer-plugin upstream repository in this PR: - apache/maven-enforcer#180

ppalaga

Thanks @gastaldi, some small docs suggestions inline.

enforcer-rules/src/site/apt/externalRules.apt.vm

- Fixes quarkusio#24880 This moves the rules to an external rule file to allow reusing enforcer rules in another modules. For more information: https://github.com/gastaldi/enforcer-rules#externalrules PS: The ExternalRules rule is tracked in [MENFORCER-422](https://issues.apache.org/jira/browse/MENFORCER-422) will be migrated to the maven-enforcer-plugin upstream repository in this PR: - apache/maven-enforcer#180

ppalaga

Great work, thanks a lot, @gastaldi !

ppalaga · 2022-08-17T09:17:07Z

Would you like to review, @michael-o ? Otherwise, I could merge.

enforcer-rules/src/site/apt/externalRules.apt.vm

Co-authored-by: Peter Palaga <[email protected]>

michael-o

Beyond those I have no objections. I will leave the merge to your judgement.

- Fixes quarkusio#24880 This moves the rules to an external rule file to allow reusing enforcer rules in another modules. For more information: https://github.com/gastaldi/enforcer-rules#externalrules PS: The ExternalRules rule is tracked in [MENFORCER-422](https://issues.apache.org/jira/browse/MENFORCER-422) will be migrated to the maven-enforcer-plugin upstream repository in this PR: - apache/maven-enforcer#180

ppalaga · 2022-08-19T08:38:47Z

Thanks, @gastaldi !

ppalaga · 2022-08-19T10:34:18Z

@michael-o do you happen to know whether an Enforcer release is planned already? Not sure where to look for that kind of info, although I am a committer.

michael-o · 2022-08-19T10:54:15Z

@michael-o do you happen to know whether an Enforcer release is planned already? Not sure where to look for that kind of info, although I am a committer.

We don't publish any plans since we are volunteers.

First of all, please complete the accompanying JIRA issue. Second, someone needs to tackle https://issues.apache.org/jira/browse/MENFORCER-407 then we can consider a release.

ppalaga · 2022-08-19T11:00:53Z

Thanks for the info @michael-o !

- Fixes quarkusio#24880 This moves the rules to an external rule file to allow reusing enforcer rules in another modules. For more information: https://github.com/gastaldi/enforcer-rules#externalrules PS: The ExternalRules rule is tracked in [MENFORCER-422](https://issues.apache.org/jira/browse/MENFORCER-422) will be migrated to the maven-enforcer-plugin upstream repository in this PR: - apache/maven-enforcer#180

gastaldi mentioned this pull request Aug 11, 2022

Share the set of banned dependencies and their replacements with Quarkus ecosystem quarkusio/quarkus#24880

Closed

ppalaga reviewed Aug 11, 2022

View reviewed changes

maven-enforcer-plugin/src/it/projects/descriptors-local-always-pass/pom.xml Outdated Show resolved Hide resolved

enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/Descriptors.java Outdated Show resolved Hide resolved

ppalaga reviewed Aug 11, 2022

View reviewed changes

enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/Descriptors.java Outdated Show resolved Hide resolved

gastaldi force-pushed the MENFORCER-422 branch from 606b254 to abc34f5 Compare August 11, 2022 23:24

gastaldi changed the title ~~[MENFORCER-422] Added descriptors rule~~ [MENFORCER-422] Added externalRules rule Aug 11, 2022

gastaldi force-pushed the MENFORCER-422 branch 2 times, most recently from 2d693c8 to cfb2511 Compare August 11, 2022 23:39

ppalaga reviewed Aug 15, 2022

View reviewed changes

enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/ExternalRules.java Outdated Show resolved Hide resolved

ppalaga reviewed Aug 15, 2022

View reviewed changes

gastaldi force-pushed the MENFORCER-422 branch 2 times, most recently from e83aef4 to 27f5283 Compare August 15, 2022 14:07

gastaldi requested a review from ppalaga August 15, 2022 14:08

gastaldi mentioned this pull request Aug 15, 2022

Use ExternalRules enforcer rule quarkusio/quarkus#27294

Merged

ppalaga reviewed Aug 16, 2022

View reviewed changes

enforcer-rules/src/site/apt/externalRules.apt.vm Outdated Show resolved Hide resolved

enforcer-rules/src/site/apt/externalRules.apt.vm Outdated Show resolved Hide resolved

enforcer-rules/src/site/apt/externalRules.apt.vm Show resolved Hide resolved

gastaldi force-pushed the MENFORCER-422 branch 2 times, most recently from 66d4717 to 77c2a95 Compare August 16, 2022 14:24

gastaldi requested a review from ppalaga August 16, 2022 14:24

ppalaga approved these changes Aug 17, 2022

View reviewed changes

michael-o requested changes Aug 17, 2022

View reviewed changes

enforcer-rules/src/site/apt/externalRules.apt.vm Outdated Show resolved Hide resolved

enforcer-rules/src/site/apt/externalRules.apt.vm Outdated Show resolved Hide resolved

[MENFORCER-422] Added externalRules rule

7646940

Co-authored-by: Peter Palaga <[email protected]>

gastaldi force-pushed the MENFORCER-422 branch from 77c2a95 to 7646940 Compare August 17, 2022 14:13

gastaldi requested a review from michael-o August 17, 2022 14:14

michael-o reviewed Aug 17, 2022

View reviewed changes

ppalaga merged commit b66d4f2 into apache:master Aug 19, 2022

gastaldi deleted the MENFORCER-422 branch November 14, 2022 17:28

slawekjaranowski added the enhancement New feature or request label Dec 22, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[MENFORCER-422] Added externalRules rule #180

[MENFORCER-422] Added externalRules rule #180

gastaldi commented Aug 11, 2022 •

edited

Loading

ppalaga left a comment

gastaldi commented Aug 11, 2022

ppalaga commented Aug 11, 2022

ppalaga left a comment

gastaldi commented Aug 15, 2022

ppalaga left a comment

ppalaga left a comment

ppalaga commented Aug 17, 2022

michael-o left a comment

ppalaga commented Aug 19, 2022

ppalaga commented Aug 19, 2022

michael-o commented Aug 19, 2022

ppalaga commented Aug 19, 2022

[MENFORCER-422] Added externalRules rule #180

[MENFORCER-422] Added externalRules rule #180

Conversation

gastaldi commented Aug 11, 2022 • edited Loading

ppalaga left a comment

Choose a reason for hiding this comment

gastaldi commented Aug 11, 2022

ppalaga commented Aug 11, 2022

ppalaga left a comment

Choose a reason for hiding this comment

gastaldi commented Aug 15, 2022

ppalaga left a comment

Choose a reason for hiding this comment

ppalaga left a comment

Choose a reason for hiding this comment

ppalaga commented Aug 17, 2022

michael-o left a comment

Choose a reason for hiding this comment

ppalaga commented Aug 19, 2022

ppalaga commented Aug 19, 2022

michael-o commented Aug 19, 2022

ppalaga commented Aug 19, 2022

gastaldi commented Aug 11, 2022 •

edited

Loading