You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by Andy Law <an...@roslin.ed.ac.uk> on 2025/01/07 22:01:41 UTC
Contributing a Pull Request for the enforcer plugin - branch etiquette
All,
I’ve written some code to extend the enforcer plugin to include a “mutually exclusive profiles” rule. I’m ready to submit a Pull Request, but I’m not quite sure of the correct procedure.
In my own projects, I tend to work primarily off a develop branch, folding features into that and then going through a release branch before moving to master/main (ala GitFlow). There does not seem to be a develop branch in the apache/maven-enforcer repository. Am I supposed to submit my Pull Request against master in that case?
Thanks in advance.
Later,
Andy
--------
Yada, yada, yada...
Disclaimer: This e-mail and any attachments are confidential and intended solely for the use of the recipient(s) to whom they are addressed. If you have received it in error, please destroy all copies and inform the sender.
The University of Edinburgh is a charitable body, registered in Scotland, with registration number SC005336. Is e buidheann carthannais a th’ ann an Oilthigh Dhùn Èideann, clàraichte an Alba, àireamh clàraidh SC005336.
Re: Contributing a Pull Request for the enforcer plugin - branch etiquette
Posted by Elliotte Rusty Harold <el...@ibiblio.org>.
maven-enforcer-plugin has not yet migrated. Most projects haven't yet. See
https://issues.apache.org/jira/projects/MENFORCER/issues/MENFORCER-473?filter=allopenissues
On Wed, Jan 8, 2025 at 9:51 AM Andy Law <an...@roslin.ed.ac.uk> wrote:
>
> …and then I realised that this relates to the “Migration from JIRA” thread…
>
> From: Andy Law <an...@roslin.ed.ac.uk>
> Date: Wednesday, 8 January 2025 at 09:35
> To: Maven Developers List <de...@maven.apache.org>
> Subject: Re: Contributing a Pull Request for the enforcer plugin - branch etiquette
> That would be easier if there was an ‘Issues’ tab on the apache/maven-enforcer repository.
>
> I presume the lack of that (plus ‘Discussions’ and ‘Wiki’ tabs) is a configuration thing.
>
> Can someone please fix that for me?
>
> Thanks in advance.
>
> Later,
>
> Andy
>
> From: Elliotte Rusty Harold <el...@ibiblio.org>
> Date: Tuesday, 7 January 2025 at 22:46
> To: Maven Developers List <de...@maven.apache.org>
> Subject: Re: Contributing a Pull Request for the enforcer plugin - branch etiquette
> This email was sent to you by someone outside the University.
> You should only click on links or attachments if you are certain that the email is genuine and the content is safe.
>
> Please start by filing an issue describing what the intended rule will
> do. It's easier to understand in prose than code.
>
> On Tue, Jan 7, 2025 at 10:02 PM Andy Law <an...@roslin.ed.ac.uk> wrote:
> >
> > All,
> >
> > I’ve written some code to extend the enforcer plugin to include a “mutually exclusive profiles” rule. I’m ready to submit a Pull Request, but I’m not quite sure of the correct procedure.
> >
> > In my own projects, I tend to work primarily off a develop branch, folding features into that and then going through a release branch before moving to master/main (ala GitFlow). There does not seem to be a develop branch in the apache/maven-enforcer repository. Am I supposed to submit my Pull Request against master in that case?
> >
> > Thanks in advance.
> >
> > Later,
> >
> > Andy
> > --------
> > Yada, yada, yada...
> >
> > Disclaimer: This e-mail and any attachments are confidential and intended solely for the use of the recipient(s) to whom they are addressed. If you have received it in error, please destroy all copies and inform the sender.
> >
> > The University of Edinburgh is a charitable body, registered in Scotland, with registration number SC005336. Is e buidheann carthannais a th’ ann an Oilthigh Dhùn Èideann, clàraichte an Alba, àireamh clàraidh SC005336.
> >
>
>
> --
> Elliotte Rusty Harold
> elharo@ibiblio.org
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
--
Elliotte Rusty Harold
elharo@ibiblio.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Contributing a Pull Request for the enforcer plugin - branch etiquette
Posted by Andy Law <an...@roslin.ed.ac.uk>.
…and then I realised that this relates to the “Migration from JIRA” thread…
From: Andy Law <an...@roslin.ed.ac.uk>
Date: Wednesday, 8 January 2025 at 09:35
To: Maven Developers List <de...@maven.apache.org>
Subject: Re: Contributing a Pull Request for the enforcer plugin - branch etiquette
That would be easier if there was an ‘Issues’ tab on the apache/maven-enforcer repository.
I presume the lack of that (plus ‘Discussions’ and ‘Wiki’ tabs) is a configuration thing.
Can someone please fix that for me?
Thanks in advance.
Later,
Andy
From: Elliotte Rusty Harold <el...@ibiblio.org>
Date: Tuesday, 7 January 2025 at 22:46
To: Maven Developers List <de...@maven.apache.org>
Subject: Re: Contributing a Pull Request for the enforcer plugin - branch etiquette
This email was sent to you by someone outside the University.
You should only click on links or attachments if you are certain that the email is genuine and the content is safe.
Please start by filing an issue describing what the intended rule will
do. It's easier to understand in prose than code.
On Tue, Jan 7, 2025 at 10:02 PM Andy Law <an...@roslin.ed.ac.uk> wrote:
>
> All,
>
> I’ve written some code to extend the enforcer plugin to include a “mutually exclusive profiles” rule. I’m ready to submit a Pull Request, but I’m not quite sure of the correct procedure.
>
> In my own projects, I tend to work primarily off a develop branch, folding features into that and then going through a release branch before moving to master/main (ala GitFlow). There does not seem to be a develop branch in the apache/maven-enforcer repository. Am I supposed to submit my Pull Request against master in that case?
>
> Thanks in advance.
>
> Later,
>
> Andy
> --------
> Yada, yada, yada...
>
> Disclaimer: This e-mail and any attachments are confidential and intended solely for the use of the recipient(s) to whom they are addressed. If you have received it in error, please destroy all copies and inform the sender.
>
> The University of Edinburgh is a charitable body, registered in Scotland, with registration number SC005336. Is e buidheann carthannais a th’ ann an Oilthigh Dhùn Èideann, clàraichte an Alba, àireamh clàraidh SC005336.
>
--
Elliotte Rusty Harold
elharo@ibiblio.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Contributing a Pull Request for the enforcer plugin - branch etiquette
Posted by Andy Law <an...@roslin.ed.ac.uk>.
That would be easier if there was an ‘Issues’ tab on the apache/maven-enforcer repository.
I presume the lack of that (plus ‘Discussions’ and ‘Wiki’ tabs) is a configuration thing.
Can someone please fix that for me?
Thanks in advance.
Later,
Andy
From: Elliotte Rusty Harold <el...@ibiblio.org>
Date: Tuesday, 7 January 2025 at 22:46
To: Maven Developers List <de...@maven.apache.org>
Subject: Re: Contributing a Pull Request for the enforcer plugin - branch etiquette
This email was sent to you by someone outside the University.
You should only click on links or attachments if you are certain that the email is genuine and the content is safe.
Please start by filing an issue describing what the intended rule will
do. It's easier to understand in prose than code.
On Tue, Jan 7, 2025 at 10:02 PM Andy Law <an...@roslin.ed.ac.uk> wrote:
>
> All,
>
> I’ve written some code to extend the enforcer plugin to include a “mutually exclusive profiles” rule. I’m ready to submit a Pull Request, but I’m not quite sure of the correct procedure.
>
> In my own projects, I tend to work primarily off a develop branch, folding features into that and then going through a release branch before moving to master/main (ala GitFlow). There does not seem to be a develop branch in the apache/maven-enforcer repository. Am I supposed to submit my Pull Request against master in that case?
>
> Thanks in advance.
>
> Later,
>
> Andy
> --------
> Yada, yada, yada...
>
> Disclaimer: This e-mail and any attachments are confidential and intended solely for the use of the recipient(s) to whom they are addressed. If you have received it in error, please destroy all copies and inform the sender.
>
> The University of Edinburgh is a charitable body, registered in Scotland, with registration number SC005336. Is e buidheann carthannais a th’ ann an Oilthigh Dhùn Èideann, clàraichte an Alba, àireamh clàraidh SC005336.
>
--
Elliotte Rusty Harold
elharo@ibiblio.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Contributing a Pull Request for the enforcer plugin - branch etiquette
Posted by Elliotte Rusty Harold <el...@ibiblio.org>.
Please start by filing an issue describing what the intended rule will
do. It's easier to understand in prose than code.
On Tue, Jan 7, 2025 at 10:02 PM Andy Law <an...@roslin.ed.ac.uk> wrote:
>
> All,
>
> I’ve written some code to extend the enforcer plugin to include a “mutually exclusive profiles” rule. I’m ready to submit a Pull Request, but I’m not quite sure of the correct procedure.
>
> In my own projects, I tend to work primarily off a develop branch, folding features into that and then going through a release branch before moving to master/main (ala GitFlow). There does not seem to be a develop branch in the apache/maven-enforcer repository. Am I supposed to submit my Pull Request against master in that case?
>
> Thanks in advance.
>
> Later,
>
> Andy
> --------
> Yada, yada, yada...
>
> Disclaimer: This e-mail and any attachments are confidential and intended solely for the use of the recipient(s) to whom they are addressed. If you have received it in error, please destroy all copies and inform the sender.
>
> The University of Edinburgh is a charitable body, registered in Scotland, with registration number SC005336. Is e buidheann carthannais a th’ ann an Oilthigh Dhùn Èideann, clàraichte an Alba, àireamh clàraidh SC005336.
>
--
Elliotte Rusty Harold
elharo@ibiblio.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Contributing a Pull Request for the enforcer plugin - branch etiquette
Posted by Andy Law <an...@roslin.ed.ac.uk>.
Bundling it all together seems like a much more effective way of doing it, though.
It turns out that I already created an Issue when I started working on it last December. I thought that I’d had some kind of senior moment when I couldn’t find the Issues in the GitHub repo, but now I head back to JIRA I realise why.
https://issues.apache.org/jira/browse/MENFORCER-513
I can create a Pull Request readily enough, if there’s someone to review/accept. Back to my initial question, should that Pull Request be directly against the master branch?
Later,
Andy
From: Elliotte Rusty Harold <el...@ibiblio.org>
Date: Wednesday, 8 January 2025 at 13:09
To: Maven Developers List <de...@maven.apache.org>
Subject: Re: Contributing a Pull Request for the enforcer plugin - branch etiquette
This email was sent to you by someone outside the University.
You should only click on links or attachments if you are certain that the email is genuine and the content is safe.
Also note that new enforcer rules do not have to ship with the plugin.
There are many that are not bundled with the core plugin such as the
extra-enforcer-rules <https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.mojohaus.org%2Fextra-enforcer-rules%2F&data=05%7C02%7C%7C83836cf38de148ca037708dd2fe5afbf%7C2e9f06b016694589878910a06934dc61%7C0%7C0%7C638719385720125512%7CUnknown%7CTWFpbGZsb3d8eyJFbXB0eU1hcGkiOnRydWUsIlYiOiIwLjAuMDAwMCIsIlAiOiJXaW4zMiIsIkFOIjoiTWFpbCIsIldUIjoyfQ%3D%3D%7C0%7C%7C%7C&sdata=wA2QLMh5qMqA69i30soQXBtoZd9CTDYFqy%2FN1aGT988%3D&reserved=0<https://www.mojohaus.org/extra-enforcer-rules/>>
and the Java Linkage checker rule
<https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fmedium.com%2Fgoogle-cloud%2Fsquash-java-linkage-bugs-before-they-bite-92af79e31bfd&data=05%7C02%7C%7C83836cf38de148ca037708dd2fe5afbf%7C2e9f06b016694589878910a06934dc61%7C0%7C0%7C638719385720143618%7CUnknown%7CTWFpbGZsb3d8eyJFbXB0eU1hcGkiOnRydWUsIlYiOiIwLjAuMDAwMCIsIlAiOiJXaW4zMiIsIkFOIjoiTWFpbCIsIldUIjoyfQ%3D%3D%7C0%7C%7C%7C&sdata=8oJzNuWjnOgRfWC2MAj56P1PkEydwufrSVFBQOhelkQ%3D&reserved=0<https://medium.com/google-cloud/squash-java-linkage-bugs-before-they-bite-92af79e31bfd>>
It is fine to publish this from your own repo without involving the
Maven Project.
On Tue, Jan 7, 2025 at 10:02 PM Andy Law <an...@roslin.ed.ac.uk> wrote:
>
> All,
>
> I’ve written some code to extend the enforcer plugin to include a “mutually exclusive profiles” rule. I’m ready to submit a Pull Request, but I’m not quite sure of the correct procedure.
>
> In my own projects, I tend to work primarily off a develop branch, folding features into that and then going through a release branch before moving to master/main (ala GitFlow). There does not seem to be a develop branch in the apache/maven-enforcer repository. Am I supposed to submit my Pull Request against master in that case?
>
> Thanks in advance.
>
> Later,
>
> Andy
> --------
> Yada, yada, yada...
>
> Disclaimer: This e-mail and any attachments are confidential and intended solely for the use of the recipient(s) to whom they are addressed. If you have received it in error, please destroy all copies and inform the sender.
>
> The University of Edinburgh is a charitable body, registered in Scotland, with registration number SC005336. Is e buidheann carthannais a th’ ann an Oilthigh Dhùn Èideann, clàraichte an Alba, àireamh clàraidh SC005336.
>
--
Elliotte Rusty Harold
elharo@ibiblio.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Contributing a Pull Request for the enforcer plugin - branch etiquette
Posted by Elliotte Rusty Harold <el...@ibiblio.org>.
Also note that new enforcer rules do not have to ship with the plugin.
There are many that are not bundled with the core plugin such as the
extra-enforcer-rules <https://www.mojohaus.org/extra-enforcer-rules/>
and the Java Linkage checker rule
<https://medium.com/google-cloud/squash-java-linkage-bugs-before-they-bite-92af79e31bfd>
It is fine to publish this from your own repo without involving the
Maven Project.
On Tue, Jan 7, 2025 at 10:02 PM Andy Law <an...@roslin.ed.ac.uk> wrote:
>
> All,
>
> I’ve written some code to extend the enforcer plugin to include a “mutually exclusive profiles” rule. I’m ready to submit a Pull Request, but I’m not quite sure of the correct procedure.
>
> In my own projects, I tend to work primarily off a develop branch, folding features into that and then going through a release branch before moving to master/main (ala GitFlow). There does not seem to be a develop branch in the apache/maven-enforcer repository. Am I supposed to submit my Pull Request against master in that case?
>
> Thanks in advance.
>
> Later,
>
> Andy
> --------
> Yada, yada, yada...
>
> Disclaimer: This e-mail and any attachments are confidential and intended solely for the use of the recipient(s) to whom they are addressed. If you have received it in error, please destroy all copies and inform the sender.
>
> The University of Edinburgh is a charitable body, registered in Scotland, with registration number SC005336. Is e buidheann carthannais a th’ ann an Oilthigh Dhùn Èideann, clàraichte an Alba, àireamh clàraidh SC005336.
>
--
Elliotte Rusty Harold
elharo@ibiblio.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org