You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@pekko.apache.org by "mdedetrich (via GitHub)" <gi...@apache.org> on 2023/05/28 10:30:17 UTC
[GitHub] [incubator-pekko-grpc] mdedetrich opened a new pull request, #81: Create NoPublish sbt plugin
mdedetrich opened a new pull request, #81:
URL: https://github.com/apache/incubator-pekko-grpc/pull/81
Regarding the PR that disabled javadoc publishing which was merged in order to get publish to work (see https://github.com/apache/incubator-pekko-grpc/pull/78) I noticed that Pekko Core implements a `NoPublish` plugin which not only sets `publish / skip := true` but also disables publishing (see https://github.com/apache/incubator-pekko/blob/main/project/Publish.scala#L41C1-L49).
In order to avoid potential publishing issues (and also just out of design, if we do not publish an sbt project there is no point in generating docs) I have just ported this solution to pekko-grpc. There is one nuance just for pekk-grpc, which is `publishLocal / skip := false` which was set in https://github.com/apache/incubator-pekko-grpc/pull/64. In order to verify there wasn't a regression I just used `show` on the various keys so I can confirm it shouldn't break anything, i.e.
## Before this PR
```
[IJ]show publish / skip
[info] maven-plugin / publish / skip
[info] false
[info] plugin-tester-java / publish / skip
[info] true
[info] benchmarks / publish / skip
[info] true
[info] sbt-plugin / publish / skip
[info] false
[info] interop-tests / publish / skip
[info] true
[info] runtime / publish / skip
[info] false
[info] codegen / publish / skip
[info] false
[info] plugin-tester-scala / publish / skip
[info] true
[info] docs / publish / skip
[info] true
[info] scalapb-protoc-plugin / publish / skip
[info] false
[info] publish / skip
[info] true
[success] Total time: 0 s, completed May 28, 2023 12:17:36 PM
[IJ]
```
```
[IJ]show publishLocal / skip
[info] maven-plugin / publishLocal / skip
[info] false
[info] plugin-tester-java / publishLocal / skip
[info] true
[info] benchmarks / publishLocal / skip
[info] true
[info] sbt-plugin / publishLocal / skip
[info] false
[info] interop-tests / publishLocal / skip
[info] false
[info] runtime / publishLocal / skip
[info] false
[info] codegen / publishLocal / skip
[info] false
[info] plugin-tester-scala / publishLocal / skip
[info] true
[info] docs / publishLocal / skip
[info] true
[info] scalapb-protoc-plugin / publishLocal / skip
[info] false
[info] publishLocal / skip
[info] true
[success] Total time: 0 s, completed May 28, 2023 12:17:51 PM
[IJ]
```
## With this PR
```
[IJ]show publish / skip
[info] maven-plugin / publish / skip
[info] false
[info] plugin-tester-java / publish / skip
[info] true
[info] benchmarks / publish / skip
[info] true
[info] sbt-plugin / publish / skip
[info] false
[info] interop-tests / publish / skip
[info] true
[info] runtime / publish / skip
[info] false
[info] codegen / publish / skip
[info] false
[info] plugin-tester-scala / publish / skip
[info] true
[info] docs / publish / skip
[info] true
[info] scalapb-protoc-plugin / publish / skip
[info] false
[info] publish / skip
[info] true
[success] Total time: 0 s, completed May 28, 2023 12:14:45 PM
```
```
[IJ]show publishLocal / skip
[info] maven-plugin / publishLocal / skip
[info] false
[info] plugin-tester-java / publishLocal / skip
[info] true
[info] benchmarks / publishLocal / skip
[info] true
[info] sbt-plugin / publishLocal / skip
[info] false
[info] interop-tests / publishLocal / skip
[info] false
[info] runtime / publishLocal / skip
[info] false
[info] codegen / publishLocal / skip
[info] false
[info] plugin-tester-scala / publishLocal / skip
[info] true
[info] docs / publishLocal / skip
[info] true
[info] scalapb-protoc-plugin / publishLocal / skip
[info] false
[info] publishLocal / skip
[info] true
[success] Total time: 0 s, completed May 28, 2023 12:15:12 PM
[IJ]
```
--
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
[GitHub] [incubator-pekko-grpc] He-Pin commented on pull request #81: Create NoPublish sbt plugin
Posted by "He-Pin (via GitHub)" <gi...@apache.org>.
He-Pin commented on PR #81:
URL: https://github.com/apache/incubator-pekko-grpc/pull/81#issuecomment-1566779694
lgtm, but it would be better we have a pekko-build-plugin .
--
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
[GitHub] [incubator-pekko-grpc] mdedetrich commented on a diff in pull request #81: Create NoPublish sbt plugin
Posted by "mdedetrich (via GitHub)" <gi...@apache.org>.
mdedetrich commented on code in PR #81:
URL: https://github.com/apache/incubator-pekko-grpc/pull/81#discussion_r1209086867
##########
project/NoPublish.scala:
##########
@@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * license agreements; and to You under the Apache License, version 2.0:
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * This file is part of the Apache Pekko project, derived from Akka.
+ */
+
+package org.apache.pekko.grpc
+
+import sbt._
+import sbt.Keys._
+
+/**
+ * For projects that are not to be published.
+ */
+object NoPublish extends AutoPlugin {
Review Comment:
I am just using the same name that is used in Pekko core. I also prefer `NoPublish` because its really a bit of a misnomer that modules which are not published still generate docs
--
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
[GitHub] [incubator-pekko-grpc] mdedetrich commented on pull request #81: Create NoPublish sbt plugin
Posted by "mdedetrich (via GitHub)" <gi...@apache.org>.
mdedetrich commented on PR #81:
URL: https://github.com/apache/incubator-pekko-grpc/pull/81#issuecomment-1566774930
@He-Pin @pjfanning Could you look into this since you are online
--
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
[GitHub] [incubator-pekko-grpc] He-Pin commented on a diff in pull request #81: Create NoPublish sbt plugin
Posted by "He-Pin (via GitHub)" <gi...@apache.org>.
He-Pin commented on code in PR #81:
URL: https://github.com/apache/incubator-pekko-grpc/pull/81#discussion_r1209086053
##########
project/NoPublish.scala:
##########
@@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * license agreements; and to You under the Apache License, version 2.0:
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * This file is part of the Apache Pekko project, derived from Akka.
+ */
+
+package org.apache.pekko.grpc
+
+import sbt._
+import sbt.Keys._
+
+/**
+ * For projects that are not to be published.
+ */
+object NoPublish extends AutoPlugin {
Review Comment:
`SkipDocPublish`?
--
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
[GitHub] [incubator-pekko-grpc] mdedetrich commented on pull request #81: Create NoPublish sbt plugin
Posted by "mdedetrich (via GitHub)" <gi...@apache.org>.
mdedetrich commented on PR #81:
URL: https://github.com/apache/incubator-pekko-grpc/pull/81#issuecomment-1566781266
> lgtm, but it would be better we have a pekko-build-plugin .
Definitely, and I want to both abstract most of this stuff as well as make it consistent between our pekko projects (currently the build structure for our pekko projects is all over the place).
Something akin to https://github.com/typelevel/sbt-typelevel but for Pekko would be fantastic.
--
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
[GitHub] [incubator-pekko-grpc] mdedetrich merged pull request #81: Create NoPublish sbt plugin
Posted by "mdedetrich (via GitHub)" <gi...@apache.org>.
mdedetrich merged PR #81:
URL: https://github.com/apache/incubator-pekko-grpc/pull/81
--
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