abhishekrb19 commented on code in PR #17444: URL: https://github.com/apache/druid/pull/17444#discussion_r1828357792
########## docs/development/build.md: ########## @@ -72,9 +72,25 @@ Putting these together, if you wish to build the source and binary distributions mvn clean install -Papache-release,dist,rat -DskipTests ``` -#### Potential issues +### Building for Development -##### Missing `pyyaml` +If you are building the project only for development, you will not need the Apache release and Apache Rat profile. Review Comment: ```suggestion For development, use only the dist profile and skip the Apache release and Apache rat profiles. ``` ########## docs/development/build.md: ########## @@ -29,34 +29,34 @@ For building the latest code in master, follow the latest version of this page [here](https://github.com/apache/druid/blob/master/docs/development/build.md): make sure it has `/master/` in the URL. -#### Prerequisites +## Prerequisites -##### Installing Java and Maven +### Installing Java and Maven - See our [Java documentation](../operations/java.md) for information about obtaining a supported JDK - [Maven version 3.x](http://maven.apache.org/download.cgi) -##### Other dependencies +### Other Dependencies - Distribution builds require Python 3.x and the `pyyaml` module. - Integration tests require `pyyaml` version 5.1 or later. -##### Downloading the source +## Downloading the Source Code ```bash git clone [email protected]:apache/druid.git cd druid ``` -#### Building from source +## Building from Source The basic command to build Druid from source is: ```bash mvn clean install ``` -This will run static analysis, unit tests, compile classes, and package the projects into JARs. It will _not_ generate the source or binary distribution tarball. +This will run static analysis, unit tests, compile classes, and package the projects into JARs. It will _not_ generate the source or binary distribution tarball. Take note that this build will take up to an hour to complete. Review Comment: Consider something like this, as the build and test time will only increase as we add more tests, extensions, etc: ```suggestion This will run static analysis, unit tests, compile classes, and package the projects into JARs. It will _not_ generate the source or binary distribution tarball. Note that this build may take some time to complete. ``` ########## docs/development/build.md: ########## @@ -72,9 +72,25 @@ Putting these together, if you wish to build the source and binary distributions mvn clean install -Papache-release,dist,rat -DskipTests ``` -#### Potential issues +### Building for Development -##### Missing `pyyaml` +If you are building the project only for development, you will not need the Apache release and Apache Rat profile. + +```bash +mvn clean install -Pdist -DskipTests +``` + +Should you want to further speed up the build, you can enable parallel building with the `-T1C` option, and exclude some static analysis checks to further speed up the build: Review Comment: ```suggestion If you want to speed up the build even more, you can enable parallel building with the `-T1C` option and skip some static analysis checks. ``` -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
