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 2023/05/22 00:39:31 UTC

[GitHub] [incubator-pekko] pjfanning opened a new pull request, #323: [DRAFT] add build instructions

pjfanning opened a new pull request, #323:
URL: https://github.com/apache/incubator-pekko/pull/323

   * it's useful if our source release has some basic build instructions
   


-- 
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] pjfanning commented on a diff in pull request #323: [DRAFT] add build instructions

Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
pjfanning commented on code in PR #323:
URL: https://github.com/apache/incubator-pekko/pull/323#discussion_r1202045978


##########
README.md:
##########
@@ -13,7 +13,16 @@ Pekko is a fork of [Akka](https://github.com/akka/akka) 2.6.x, prior to the Akka
 Reference Documentation
 -----------------------
 
-**TODO add documentation links**
+See https://pekko.apache.org for the documentation including the API docs.
+
+Building from Source
+--------------------
+
+* You will need to install [sbt](https://www.scala-sbt.org/) if you don't already have it installed
+* Use git to clone the [repo](https://github.com/apache/incubator-pekko) or download a source release from https://pekko.apache.org
+* Open a command window and change directory to the directory where you installed the source
+* `sbt test` will build the jars and run the unit tests
+* `sbt docs/paradox` will build the docs

Review Comment:
   I added `compile` and a few more



-- 
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] He-Pin commented on a diff in pull request #323: [DRAFT] add build instructions

Posted by "He-Pin (via GitHub)" <gi...@apache.org>.
He-Pin commented on code in PR #323:
URL: https://github.com/apache/incubator-pekko/pull/323#discussion_r1199915396


##########
README.md:
##########
@@ -13,7 +13,16 @@ Pekko is a fork of [Akka](https://github.com/akka/akka) 2.6.x, prior to the Akka
 Reference Documentation
 -----------------------
 
-**TODO add documentation links**
+See https://pekko.apache.org for the documentation including the API docs.
+
+Building from Source
+--------------------
+
+* You will need to install [sbt](https://www.scala-sbt.org/) if you don't already have it installed
+* Use git to clone the [repo](https://github.com/apache/incubator-pekko) or download a source release from https://pekko.apache.org
+* Open a command window and change directory to the directory where you installed the source
+* `sbt test` will build the jars and run the unit tests

Review Comment:
   add `sbt compile` and how to do cross-build too?



-- 
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] pjfanning commented on a diff in pull request #323: [DRAFT] add build instructions

Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
pjfanning commented on code in PR #323:
URL: https://github.com/apache/incubator-pekko/pull/323#discussion_r1200216285


##########
README.md:
##########
@@ -13,7 +13,16 @@ Pekko is a fork of [Akka](https://github.com/akka/akka) 2.6.x, prior to the Akka
 Reference Documentation
 -----------------------
 
-**TODO add documentation links**
+See https://pekko.apache.org for the documentation including the API docs.
+
+Building from Source
+--------------------
+
+* You will need to install [sbt](https://www.scala-sbt.org/) if you don't already have it installed
+* Use git to clone the [repo](https://github.com/apache/incubator-pekko) or download a source release from https://pekko.apache.org
+* Open a command window and change directory to the directory where you installed the source
+* `sbt test` will build the jars and run the unit tests
+* `sbt docs/paradox` will build the docs

Review Comment:
   We need something like for our ASF Incubator reviewers. Scala and sbt are not used by many of those reviewers. They can easily reject our releases if we don't make an effort to make their reviews easy.



-- 
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] He-Pin commented on a diff in pull request #323: [DRAFT] add build instructions

Posted by "He-Pin (via GitHub)" <gi...@apache.org>.
He-Pin commented on code in PR #323:
URL: https://github.com/apache/incubator-pekko/pull/323#discussion_r1200231417


##########
README.md:
##########
@@ -13,7 +13,16 @@ Pekko is a fork of [Akka](https://github.com/akka/akka) 2.6.x, prior to the Akka
 Reference Documentation
 -----------------------
 
-**TODO add documentation links**
+See https://pekko.apache.org for the documentation including the API docs.
+
+Building from Source
+--------------------
+
+* You will need to install [sbt](https://www.scala-sbt.org/) if you don't already have it installed
+* Use git to clone the [repo](https://github.com/apache/incubator-pekko) or download a source release from https://pekko.apache.org
+* Open a command window and change directory to the directory where you installed the source
+* `sbt test` will build the jars and run the unit tests
+* `sbt docs/paradox` will build the docs

Review Comment:
   Then we need to add `sbt compile` and how to do cross compiling too.
   



-- 
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] He-Pin commented on a diff in pull request #323: [DRAFT] add build instructions

Posted by "He-Pin (via GitHub)" <gi...@apache.org>.
He-Pin commented on code in PR #323:
URL: https://github.com/apache/incubator-pekko/pull/323#discussion_r1199915292


##########
README.md:
##########
@@ -13,7 +13,16 @@ Pekko is a fork of [Akka](https://github.com/akka/akka) 2.6.x, prior to the Akka
 Reference Documentation
 -----------------------
 
-**TODO add documentation links**
+See https://pekko.apache.org for the documentation including the API docs.
+
+Building from Source
+--------------------
+
+* You will need to install [sbt](https://www.scala-sbt.org/) if you don't already have it installed
+* Use git to clone the [repo](https://github.com/apache/incubator-pekko) or download a source release from https://pekko.apache.org
+* Open a command window and change directory to the directory where you installed the source
+* `sbt test` will build the jars and run the unit tests
+* `sbt docs/paradox` will build the docs

Review Comment:
   There are some already in the sbt help messages too. more details can be added to the Contributor guide.



-- 
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] He-Pin commented on a diff in pull request #323: [DRAFT] add build instructions

Posted by "He-Pin (via GitHub)" <gi...@apache.org>.
He-Pin commented on code in PR #323:
URL: https://github.com/apache/incubator-pekko/pull/323#discussion_r1200231417


##########
README.md:
##########
@@ -13,7 +13,16 @@ Pekko is a fork of [Akka](https://github.com/akka/akka) 2.6.x, prior to the Akka
 Reference Documentation
 -----------------------
 
-**TODO add documentation links**
+See https://pekko.apache.org for the documentation including the API docs.
+
+Building from Source
+--------------------
+
+* You will need to install [sbt](https://www.scala-sbt.org/) if you don't already have it installed
+* Use git to clone the [repo](https://github.com/apache/incubator-pekko) or download a source release from https://pekko.apache.org
+* Open a command window and change directory to the directory where you installed the source
+* `sbt test` will build the jars and run the unit tests
+* `sbt docs/paradox` will build the docs

Review Comment:
   Then we need to add `sbt compile` and how to do cross compiling too.
   And crosslink to https://github.com/apache/incubator-pekko/blob/main/CONTRIBUTING.md#getting-started-with-sbt



-- 
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] He-Pin commented on a diff in pull request #323: [DRAFT] add build instructions

Posted by "He-Pin (via GitHub)" <gi...@apache.org>.
He-Pin commented on code in PR #323:
URL: https://github.com/apache/incubator-pekko/pull/323#discussion_r1199915396


##########
README.md:
##########
@@ -13,7 +13,16 @@ Pekko is a fork of [Akka](https://github.com/akka/akka) 2.6.x, prior to the Akka
 Reference Documentation
 -----------------------
 
-**TODO add documentation links**
+See https://pekko.apache.org for the documentation including the API docs.
+
+Building from Source
+--------------------
+
+* You will need to install [sbt](https://www.scala-sbt.org/) if you don't already have it installed
+* Use git to clone the [repo](https://github.com/apache/incubator-pekko) or download a source release from https://pekko.apache.org
+* Open a command window and change directory to the directory where you installed the source
+* `sbt test` will build the jars and run the unit tests

Review Comment:
   add `sbt compile` and how to do cross-build too?



-- 
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] pjfanning merged pull request #323: add build instructions

Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
pjfanning merged PR #323:
URL: https://github.com/apache/incubator-pekko/pull/323


-- 
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