This is an automated email from the ASF dual-hosted git repository. fanningpj pushed a commit to branch build-version in repository https://gitbox.apache.org/repos/asf/incubator-pekko.git
commit c82798bafc9201654d6f1db20d8a8efe4e5b7923 Author: PJ Fanning <[email protected]> AuthorDate: Sat May 27 16:52:40 2023 +0100 version-number-in-build --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 50a82cbcf8..8e46eae825 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ See https://pekko.apache.org for the documentation including the API docs. The d ### Running the Build - Open a command window and change directory to your preferred base directory - Use git to clone the [repo](https://github.com/apache/incubator-pekko) or download a source release from https://pekko.apache.org (and unzip or untar it, as appropriate) -- Change directory to the directory where you installed the source +- Change directory to the directory where you installed the source (you should have a file called `build.sbt` in this directory) - `sbt compile` compiles the main source for project default version of Scala (2.13) - `sbt +compile` will compile for all supported versions of Scala - `sbt test` will compile the code and run the unit tests @@ -39,6 +39,9 @@ See https://pekko.apache.org for the documentation including the API docs. The d - the `index.html` file will appear in `target/paradox/site/main/` - `sbt unidoc` will build the Javadocs for all the modules and load them to one place (may require Graphviz, see Prerequisites above) - the `index.html` file will appear in `target/scala-2.13/unidoc/` +- `sbt sourceDistGenerate` will generate source release to `target/dist/` +- The version number that appears in filenames and docs is derived (by default). If you want to control the version number, add a file `version.sbt` to the same directory that has the `build.sbt`. An example: + - `ThisBuild / version := "1.0.0"` ## Community --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
