You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@pekko.apache.org by "pjfanning (via GitHub)" <gi...@apache.org> on 2024/01/23 23:23:10 UTC
[PR] [DRAFT] try to centralise pom name change logic [incubator-pekko]
pjfanning opened a new pull request, #1035:
URL: https://github.com/apache/incubator-pekko/pull/1035
This has been causing compile issues for me locally
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
Re: [PR] [DRAFT] try to centralise pom name change logic [incubator-pekko]
Posted by "gmethvin (via GitHub)" <gi...@apache.org>.
gmethvin commented on PR #1035:
URL: https://github.com/apache/incubator-pekko/pull/1035#issuecomment-1907682177
> interestingly it appears that sbt and other build tools were designed around name being the machine representation of the project name (which is why for example, in sbt, the name setting key is what is displayed in the sbt shell for the project name).
Yeah that's interesting, sbt actually has a `normalizedName` that it generates based on the `name`, so if you did set your `name` to `Pekko Streams` then it would generate `pekko-streams` to be used as the artifact ID. So in that sense `name` is _intended_ to be a human-readable name, but in my experience this "feature" isn't really used because it creates more confusion.
I don't know what the common conventions are for `<name>` in Maven POM files, but it seems like other Apache projects tend to use a fully pretty-printed version of the name.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
Re: [PR] [DRAFT] try to centralise pom name change logic [incubator-pekko]
Posted by "mdedetrich (via GitHub)" <gi...@apache.org>.
mdedetrich commented on PR #1035:
URL: https://github.com/apache/incubator-pekko/pull/1035#issuecomment-1907089555
@pjfanning This can be fixed in a much nicer way, likely with a single line at https://github.com/mdedetrich/sbt-apache-sonatype
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
Re: [PR] [DRAFT] try to centralise pom name change logic [incubator-pekko]
Posted by "mdedetrich (via GitHub)" <gi...@apache.org>.
mdedetrich commented on PR #1035:
URL: https://github.com/apache/incubator-pekko/pull/1035#issuecomment-1907717255
> Yeah that's interesting, sbt actually has a `normalizedName` that it generates based on the `name`, so if you did set your `name` to `Pekko Streams` then it would generate `pekko-streams` to be used as the artifact ID. So in that sense `name` is _intended_ to be a human-readable name, but in my experience this "feature" isn't really used because it creates more confusion.
>
> I don't know what the common conventions are for `<name>` in Maven POM files, but it seems like other Apache projects tend to use a fully pretty-printed version of the name.
Thanks for the context, it does seem that `name` field should be human readable but due to various reasons people don't do that anymore, in terms of confusion it also doesn't help that sites like https://mvnrepository.com/ take the machine readable values and pretty prints. Lets wait for confirmation from ASF if its indeed meant to be human readable and then I can update the PR as necessary.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
Re: [PR] [DRAFT] try to centralise pom name change logic [incubator-pekko]
Posted by "mdedetrich (via GitHub)" <gi...@apache.org>.
mdedetrich commented on PR #1035:
URL: https://github.com/apache/incubator-pekko/pull/1035#issuecomment-1907873342
Given the latest info, I believe I was overthinking this a bit and it does appear that `name` should indeed be human readable. I have updated the [PR](https://github.com/mdedetrich/sbt-apache-sonatype/pull/31).
@pjfanning Let me know if this is acceptable and if so I will merge + deploy so we can start getting this integrated into Pekko and its modules.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
Re: [PR] [DRAFT] try to centralise pom name change logic [incubator-pekko]
Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
pjfanning commented on PR #1035:
URL: https://github.com/apache/incubator-pekko/pull/1035#issuecomment-1907878984
to be clear, this PR is not a solution - I raised it to highlight how it causes compile issues for the Pekko runtime code
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
Re: [PR] [DRAFT] try to centralise pom name change logic [incubator-pekko]
Posted by "mdedetrich (via GitHub)" <gi...@apache.org>.
mdedetrich commented on PR #1035:
URL: https://github.com/apache/incubator-pekko/pull/1035#issuecomment-1907426732
@pjfanning So I went down the rabbit hole of the whole `pom.xml` name field issue and I created a PR for this with tests at https://github.com/mdedetrich/sbt-apache-sonatype/pull/31 with proper tests and everything. The advantage of this implementation is that it leaves everything else regarding the sbt build in tact, only the final pom.xml is being modified (which is what gets published).
What is still unclear is what format should this name field be, i.e. should it be a completely human readable `Apache Pekko Streams` or `apache-pekko-streams` which https://mvnrepository.com/ then pretty prints to `Apache Pekko Streams`. I can’t find any ASF rule on this actually.
I also sent a message to the mailing list on this. If we do actually need a human readable representation in the name field then I need to add a `apacheSonatypeArtifactNamePrettifier` `SettingKey` to that PR which will be a function that will pretty the `apache-pekko-streams` to `Apache Pekko Streams`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
Re: [PR] [DRAFT] try to centralise pom name change logic [incubator-pekko]
Posted by "gmethvin (via GitHub)" <gi...@apache.org>.
gmethvin commented on PR #1035:
URL: https://github.com/apache/incubator-pekko/pull/1035#issuecomment-1907479386
I think if we're going to bother having a display name that's different from the artifact ID, we might as well have a fully pretty-printed version of the name. If we use something that looks like an artifact ID it might confuse people at first glance.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
Re: [PR] [DRAFT] try to centralise pom name change logic [incubator-pekko]
Posted by "mdedetrich (via GitHub)" <gi...@apache.org>.
mdedetrich commented on PR #1035:
URL: https://github.com/apache/incubator-pekko/pull/1035#issuecomment-1907487115
> I think if we're going to bother having a display name that's different from the artifact ID, we might as well have a fully pretty-printed version of the name. If we use something that looks like an artifact ID it might confuse people at first glance.
Agreed, the situation itself is pretty confusing. Would like to get clarity on what the actual ASF rule on this is, human readable name would make it more clear but interestingly it appears that sbt and other build tools were designed around `name` being the machine representation of the project name (which is why in sbt, the `name` setting key is what is displayed in the sbt shell for the project name).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
Re: [PR] [DRAFT] try to centralise pom name change logic [incubator-pekko]
Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
pjfanning closed pull request #1035: [DRAFT] try to centralise pom name change logic
URL: https://github.com/apache/incubator-pekko/pull/1035
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org