matrei commented on code in PR #14880: URL: https://github.com/apache/grails-core/pull/14880#discussion_r2188427666
########## CONTRIBUTING.md: ########## @@ -168,7 +168,7 @@ To build the code, without tests, simply run: If you encounter out of memory errors when trying to run the build, try adjusting Gradle build settings. For example: - export GRADLE_OPTS="-Xmx2G -Xms2G -XX:NewSize=512m -XX:MaxNewSize=512m" + export GRADLE_OPTS="-Xmx2G -Xms5G" Review Comment: Should these be ```shell export GRADLE_OPTS="-Xms2G -Xmx5G" ``` ########## INSTALL: ########## @@ -1 +1,82 @@ -For installation instructions see <https://docs.grails.org/latest/guide/single.html#build>. +Grails Installation Guide +======================= + +Grails is a powerful Groovy-based web application framework for the JVM built on top of Spring Boot that has many plugins to further extend its functionality. The full documentation for how to install Grails via different mechanisms & use it can be found at `https://docs.grails.org/latest`. This document specifically covers the basic building & installation of Grails from a source distribution. + +How to use the source distribution +------------------------------ +Grails is ultimately a set of libraries & Gradle build plugins that are used to create a Grails Application. Getting started with Grails requires knowing which libraries & which Gradle plugins to use. Since these dependencies will vary based on the application type, Grails also ships with a set of CLI commands to assist with application generation. Thus, the source distribution can be used to build & publish the code used by Grails applications. It can also be used to build the CLI commands that assist with application generation for that published code. + +Requirements & Tooling Setup for Building +------------------------------ +Grails requires a Java Development Kit (JDK) & Gradle (https://www.gradle.org) to build. Only specific versions are supported. A configuration file, `.sdkmanrc`, for SDKMAN! (https://sdkman.io/) exists in the source root to make it easier to setup the preferred tooling. This file contains the minimum versions to build Grails. + +If SDKMAN! is installed, the tooling can be selected by running the following command at the source root: + + sdk env install + +Otherwise, Gradle must be bootstrapped so that the correct version is used. The recommended way to do this is to use the Gradle Wrapper, which can be setup with files included in the source distribution. The wrapper will automatically download the correct version of Gradle specified in the `gradle/wrapper/gradle-wrapper.properties` file. To setup the wrapper, run the following commands: + + cd gradle-bootstrap + gradle bootstrap + +For the remaining commands in this document: `gradle` is used if tooling is installed with SDKMAN & `./gradlew` if the Gradle Wrapper is used. + +Requirements for Testing +------------------------------ +Grails has a comprehensive test suite that includes unit, integration, and functional tests. The functional tests use Testcontainers (https://www.testcontainers.org/), which requires a container runtime. In the event that a container runtime is not available, the tests can be skipped by using the argument the argument `-PskipTests`. Some container runtimes require more configuration than others. Please see the Testcontainers documentation at https://java.testcontainers.org/features/configuration/ for how to customize the container runtime used by Testcontainers. + +Project Structure +------------------------------ +The source of Grails is a multi-project Gradle build that uses composite multi-project builds via Gradle's includeBuild feature. The main project is `grails-core`, which contains the core framework code and all libraries that an end user would use in their application. The `grails-gradle` project contains code meant to run on the gradle build classpath. `grails-forge` contains tooling related to App Generation. + +Building grails-core +------------------------------ +To build libraries a Grails Application would use, run the following command at the source root: Review Comment: Suggestion: To build the libraries ... ########## INSTALL: ########## @@ -1 +1,82 @@ -For installation instructions see <https://docs.grails.org/latest/guide/single.html#build>. +Grails Installation Guide +======================= + +Grails is a powerful Groovy-based web application framework for the JVM built on top of Spring Boot that has many plugins to further extend its functionality. The full documentation for how to install Grails via different mechanisms & use it can be found at `https://docs.grails.org/latest`. This document specifically covers the basic building & installation of Grails from a source distribution. + +How to use the source distribution +------------------------------ +Grails is ultimately a set of libraries & Gradle build plugins that are used to create a Grails Application. Getting started with Grails requires knowing which libraries & which Gradle plugins to use. Since these dependencies will vary based on the application type, Grails also ships with a set of CLI commands to assist with application generation. Thus, the source distribution can be used to build & publish the code used by Grails applications. It can also be used to build the CLI commands that assist with application generation for that published code. + +Requirements & Tooling Setup for Building +------------------------------ +Grails requires a Java Development Kit (JDK) & Gradle (https://www.gradle.org) to build. Only specific versions are supported. A configuration file, `.sdkmanrc`, for SDKMAN! (https://sdkman.io/) exists in the source root to make it easier to setup the preferred tooling. This file contains the minimum versions to build Grails. Review Comment: - Align on no trailing slash for URLs? - Is it true that the `.sdkmanrc` file "contains the minimum versions to build Grails"? ########## INSTALL: ########## @@ -1 +1,82 @@ -For installation instructions see <https://docs.grails.org/latest/guide/single.html#build>. +Grails Installation Guide +======================= + +Grails is a powerful Groovy-based web application framework for the JVM built on top of Spring Boot that has many plugins to further extend its functionality. The full documentation for how to install Grails via different mechanisms & use it can be found at `https://docs.grails.org/latest`. This document specifically covers the basic building & installation of Grails from a source distribution. + +How to use the source distribution +------------------------------ +Grails is ultimately a set of libraries & Gradle build plugins that are used to create a Grails Application. Getting started with Grails requires knowing which libraries & which Gradle plugins to use. Since these dependencies will vary based on the application type, Grails also ships with a set of CLI commands to assist with application generation. Thus, the source distribution can be used to build & publish the code used by Grails applications. It can also be used to build the CLI commands that assist with application generation for that published code. Review Comment: Suggestion: Use literal `and` instead of `&` in running text. ########## INSTALL: ########## @@ -1 +1,82 @@ -For installation instructions see <https://docs.grails.org/latest/guide/single.html#build>. +Grails Installation Guide +======================= + +Grails is a powerful Groovy-based web application framework for the JVM built on top of Spring Boot that has many plugins to further extend its functionality. The full documentation for how to install Grails via different mechanisms & use it can be found at `https://docs.grails.org/latest`. This document specifically covers the basic building & installation of Grails from a source distribution. + +How to use the source distribution +------------------------------ +Grails is ultimately a set of libraries & Gradle build plugins that are used to create a Grails Application. Getting started with Grails requires knowing which libraries & which Gradle plugins to use. Since these dependencies will vary based on the application type, Grails also ships with a set of CLI commands to assist with application generation. Thus, the source distribution can be used to build & publish the code used by Grails applications. It can also be used to build the CLI commands that assist with application generation for that published code. + +Requirements & Tooling Setup for Building +------------------------------ +Grails requires a Java Development Kit (JDK) & Gradle (https://www.gradle.org) to build. Only specific versions are supported. A configuration file, `.sdkmanrc`, for SDKMAN! (https://sdkman.io/) exists in the source root to make it easier to setup the preferred tooling. This file contains the minimum versions to build Grails. + +If SDKMAN! is installed, the tooling can be selected by running the following command at the source root: + + sdk env install + +Otherwise, Gradle must be bootstrapped so that the correct version is used. The recommended way to do this is to use the Gradle Wrapper, which can be setup with files included in the source distribution. The wrapper will automatically download the correct version of Gradle specified in the `gradle/wrapper/gradle-wrapper.properties` file. To setup the wrapper, run the following commands: + + cd gradle-bootstrap + gradle bootstrap + +For the remaining commands in this document: `gradle` is used if tooling is installed with SDKMAN & `./gradlew` if the Gradle Wrapper is used. + +Requirements for Testing +------------------------------ +Grails has a comprehensive test suite that includes unit, integration, and functional tests. The functional tests use Testcontainers (https://www.testcontainers.org/), which requires a container runtime. In the event that a container runtime is not available, the tests can be skipped by using the argument the argument `-PskipTests`. Some container runtimes require more configuration than others. Please see the Testcontainers documentation at https://java.testcontainers.org/features/configuration/ for how to customize the container runtime used by Testcontainers. + +Project Structure +------------------------------ +The source of Grails is a multi-project Gradle build that uses composite multi-project builds via Gradle's includeBuild feature. The main project is `grails-core`, which contains the core framework code and all libraries that an end user would use in their application. The `grails-gradle` project contains code meant to run on the gradle build classpath. `grails-forge` contains tooling related to App Generation. + +Building grails-core +------------------------------ +To build libraries a Grails Application would use, run the following command at the source root: + + ./gradlew build -PskipTests + +This will build the project and skip any tests. + +Building grails-gradle +------------------------------ +To build libraries for the Gradle to use, run the following command under the `grails-gradle` directory: + + ./gradlew build -PskipTests + +Building grails-forge +------------------------------ +To build the Grails Forge, which is used for application generation, run the following command under the `grails-forge` directory: + + ./gradlew build -PskipTests + +Using built libraries +------------------------------ +To use the built libraries in a Grails Application, libraries must be published to a Maven repository. Since the source distribution is meant for offline use, this document covers how to publish them locally. To build the full project, run the following command at the source root: Review Comment: command -> commands? ########## INSTALL: ########## @@ -1 +1,82 @@ -For installation instructions see <https://docs.grails.org/latest/guide/single.html#build>. +Grails Installation Guide +======================= + +Grails is a powerful Groovy-based web application framework for the JVM built on top of Spring Boot that has many plugins to further extend its functionality. The full documentation for how to install Grails via different mechanisms & use it can be found at `https://docs.grails.org/latest`. This document specifically covers the basic building & installation of Grails from a source distribution. + +How to use the source distribution +------------------------------ +Grails is ultimately a set of libraries & Gradle build plugins that are used to create a Grails Application. Getting started with Grails requires knowing which libraries & which Gradle plugins to use. Since these dependencies will vary based on the application type, Grails also ships with a set of CLI commands to assist with application generation. Thus, the source distribution can be used to build & publish the code used by Grails applications. It can also be used to build the CLI commands that assist with application generation for that published code. + +Requirements & Tooling Setup for Building +------------------------------ +Grails requires a Java Development Kit (JDK) & Gradle (https://www.gradle.org) to build. Only specific versions are supported. A configuration file, `.sdkmanrc`, for SDKMAN! (https://sdkman.io/) exists in the source root to make it easier to setup the preferred tooling. This file contains the minimum versions to build Grails. + +If SDKMAN! is installed, the tooling can be selected by running the following command at the source root: + + sdk env install + +Otherwise, Gradle must be bootstrapped so that the correct version is used. The recommended way to do this is to use the Gradle Wrapper, which can be setup with files included in the source distribution. The wrapper will automatically download the correct version of Gradle specified in the `gradle/wrapper/gradle-wrapper.properties` file. To setup the wrapper, run the following commands: + + cd gradle-bootstrap + gradle bootstrap + +For the remaining commands in this document: `gradle` is used if tooling is installed with SDKMAN & `./gradlew` if the Gradle Wrapper is used. + +Requirements for Testing +------------------------------ +Grails has a comprehensive test suite that includes unit, integration, and functional tests. The functional tests use Testcontainers (https://www.testcontainers.org/), which requires a container runtime. In the event that a container runtime is not available, the tests can be skipped by using the argument the argument `-PskipTests`. Some container runtimes require more configuration than others. Please see the Testcontainers documentation at https://java.testcontainers.org/features/configuration/ for how to customize the container runtime used by Testcontainers. + +Project Structure +------------------------------ +The source of Grails is a multi-project Gradle build that uses composite multi-project builds via Gradle's includeBuild feature. The main project is `grails-core`, which contains the core framework code and all libraries that an end user would use in their application. The `grails-gradle` project contains code meant to run on the gradle build classpath. `grails-forge` contains tooling related to App Generation. + +Building grails-core +------------------------------ +To build libraries a Grails Application would use, run the following command at the source root: + + ./gradlew build -PskipTests + +This will build the project and skip any tests. + +Building grails-gradle +------------------------------ +To build libraries for the Gradle to use, run the following command under the `grails-gradle` directory: + + ./gradlew build -PskipTests + +Building grails-forge +------------------------------ +To build the Grails Forge, which is used for application generation, run the following command under the `grails-forge` directory: + + ./gradlew build -PskipTests + +Using built libraries +------------------------------ +To use the built libraries in a Grails Application, libraries must be published to a Maven repository. Since the source distribution is meant for offline use, this document covers how to publish them locally. To build the full project, run the following command at the source root: + + cd grails-gradle && ./gradlew build publishToMavenLocal -PskipTests && cd .. + ./gradlew build publishToMavenLocal -PskipTests && cd .. + cd /grails-forge && ./gradlew build publishToMavenLocal -PskipTests Review Comment: Should `/grails-forge` start with `/`? ########## INSTALL: ########## @@ -1 +1,82 @@ -For installation instructions see <https://docs.grails.org/latest/guide/single.html#build>. +Grails Installation Guide +======================= + +Grails is a powerful Groovy-based web application framework for the JVM built on top of Spring Boot that has many plugins to further extend its functionality. The full documentation for how to install Grails via different mechanisms & use it can be found at `https://docs.grails.org/latest`. This document specifically covers the basic building & installation of Grails from a source distribution. + +How to use the source distribution +------------------------------ +Grails is ultimately a set of libraries & Gradle build plugins that are used to create a Grails Application. Getting started with Grails requires knowing which libraries & which Gradle plugins to use. Since these dependencies will vary based on the application type, Grails also ships with a set of CLI commands to assist with application generation. Thus, the source distribution can be used to build & publish the code used by Grails applications. It can also be used to build the CLI commands that assist with application generation for that published code. + +Requirements & Tooling Setup for Building +------------------------------ +Grails requires a Java Development Kit (JDK) & Gradle (https://www.gradle.org) to build. Only specific versions are supported. A configuration file, `.sdkmanrc`, for SDKMAN! (https://sdkman.io/) exists in the source root to make it easier to setup the preferred tooling. This file contains the minimum versions to build Grails. + +If SDKMAN! is installed, the tooling can be selected by running the following command at the source root: + + sdk env install + +Otherwise, Gradle must be bootstrapped so that the correct version is used. The recommended way to do this is to use the Gradle Wrapper, which can be setup with files included in the source distribution. The wrapper will automatically download the correct version of Gradle specified in the `gradle/wrapper/gradle-wrapper.properties` file. To setup the wrapper, run the following commands: Review Comment: Suggestion: setup -> set up ########## README.md: ########## @@ -33,6 +33,9 @@ Software Foundation. The core framework is very extensible and there are numerou available that provide easy integration of add-on features. To assist in getting started, various Application generators exist and are provided by the Apache Grails team. +# Using the source distribution Review Comment: Should this be a H1? ########## INSTALL: ########## @@ -1 +1,82 @@ -For installation instructions see <https://docs.grails.org/latest/guide/single.html#build>. +Grails Installation Guide +======================= + +Grails is a powerful Groovy-based web application framework for the JVM built on top of Spring Boot that has many plugins to further extend its functionality. The full documentation for how to install Grails via different mechanisms & use it can be found at `https://docs.grails.org/latest`. This document specifically covers the basic building & installation of Grails from a source distribution. + +How to use the source distribution +------------------------------ +Grails is ultimately a set of libraries & Gradle build plugins that are used to create a Grails Application. Getting started with Grails requires knowing which libraries & which Gradle plugins to use. Since these dependencies will vary based on the application type, Grails also ships with a set of CLI commands to assist with application generation. Thus, the source distribution can be used to build & publish the code used by Grails applications. It can also be used to build the CLI commands that assist with application generation for that published code. + +Requirements & Tooling Setup for Building +------------------------------ +Grails requires a Java Development Kit (JDK) & Gradle (https://www.gradle.org) to build. Only specific versions are supported. A configuration file, `.sdkmanrc`, for SDKMAN! (https://sdkman.io/) exists in the source root to make it easier to setup the preferred tooling. This file contains the minimum versions to build Grails. + +If SDKMAN! is installed, the tooling can be selected by running the following command at the source root: + + sdk env install + +Otherwise, Gradle must be bootstrapped so that the correct version is used. The recommended way to do this is to use the Gradle Wrapper, which can be setup with files included in the source distribution. The wrapper will automatically download the correct version of Gradle specified in the `gradle/wrapper/gradle-wrapper.properties` file. To setup the wrapper, run the following commands: + + cd gradle-bootstrap + gradle bootstrap + +For the remaining commands in this document: `gradle` is used if tooling is installed with SDKMAN & `./gradlew` if the Gradle Wrapper is used. + +Requirements for Testing +------------------------------ +Grails has a comprehensive test suite that includes unit, integration, and functional tests. The functional tests use Testcontainers (https://www.testcontainers.org/), which requires a container runtime. In the event that a container runtime is not available, the tests can be skipped by using the argument the argument `-PskipTests`. Some container runtimes require more configuration than others. Please see the Testcontainers documentation at https://java.testcontainers.org/features/configuration/ for how to customize the container runtime used by Testcontainers. + +Project Structure +------------------------------ +The source of Grails is a multi-project Gradle build that uses composite multi-project builds via Gradle's includeBuild feature. The main project is `grails-core`, which contains the core framework code and all libraries that an end user would use in their application. The `grails-gradle` project contains code meant to run on the gradle build classpath. `grails-forge` contains tooling related to App Generation. + +Building grails-core +------------------------------ +To build libraries a Grails Application would use, run the following command at the source root: + + ./gradlew build -PskipTests + +This will build the project and skip any tests. + +Building grails-gradle +------------------------------ +To build libraries for the Gradle to use, run the following command under the `grails-gradle` directory: + + ./gradlew build -PskipTests + +Building grails-forge +------------------------------ +To build the Grails Forge, which is used for application generation, run the following command under the `grails-forge` directory: + + ./gradlew build -PskipTests + +Using built libraries +------------------------------ +To use the built libraries in a Grails Application, libraries must be published to a Maven repository. Since the source distribution is meant for offline use, this document covers how to publish them locally. To build the full project, run the following command at the source root: + + cd grails-gradle && ./gradlew build publishToMavenLocal -PskipTests && cd .. + ./gradlew build publishToMavenLocal -PskipTests && cd .. Review Comment: Should this end with `&& cd ..`? ########## INSTALL: ########## @@ -1 +1,82 @@ -For installation instructions see <https://docs.grails.org/latest/guide/single.html#build>. +Grails Installation Guide +======================= + +Grails is a powerful Groovy-based web application framework for the JVM built on top of Spring Boot that has many plugins to further extend its functionality. The full documentation for how to install Grails via different mechanisms & use it can be found at `https://docs.grails.org/latest`. This document specifically covers the basic building & installation of Grails from a source distribution. + +How to use the source distribution +------------------------------ +Grails is ultimately a set of libraries & Gradle build plugins that are used to create a Grails Application. Getting started with Grails requires knowing which libraries & which Gradle plugins to use. Since these dependencies will vary based on the application type, Grails also ships with a set of CLI commands to assist with application generation. Thus, the source distribution can be used to build & publish the code used by Grails applications. It can also be used to build the CLI commands that assist with application generation for that published code. + +Requirements & Tooling Setup for Building +------------------------------ +Grails requires a Java Development Kit (JDK) & Gradle (https://www.gradle.org) to build. Only specific versions are supported. A configuration file, `.sdkmanrc`, for SDKMAN! (https://sdkman.io/) exists in the source root to make it easier to setup the preferred tooling. This file contains the minimum versions to build Grails. + +If SDKMAN! is installed, the tooling can be selected by running the following command at the source root: + + sdk env install + +Otherwise, Gradle must be bootstrapped so that the correct version is used. The recommended way to do this is to use the Gradle Wrapper, which can be setup with files included in the source distribution. The wrapper will automatically download the correct version of Gradle specified in the `gradle/wrapper/gradle-wrapper.properties` file. To setup the wrapper, run the following commands: + + cd gradle-bootstrap + gradle bootstrap + +For the remaining commands in this document: `gradle` is used if tooling is installed with SDKMAN & `./gradlew` if the Gradle Wrapper is used. + +Requirements for Testing +------------------------------ +Grails has a comprehensive test suite that includes unit, integration, and functional tests. The functional tests use Testcontainers (https://www.testcontainers.org/), which requires a container runtime. In the event that a container runtime is not available, the tests can be skipped by using the argument the argument `-PskipTests`. Some container runtimes require more configuration than others. Please see the Testcontainers documentation at https://java.testcontainers.org/features/configuration/ for how to customize the container runtime used by Testcontainers. Review Comment: Align no no trailing slash for URLs? ########## INSTALL: ########## @@ -1 +1,82 @@ -For installation instructions see <https://docs.grails.org/latest/guide/single.html#build>. +Grails Installation Guide +======================= + +Grails is a powerful Groovy-based web application framework for the JVM built on top of Spring Boot that has many plugins to further extend its functionality. The full documentation for how to install Grails via different mechanisms & use it can be found at `https://docs.grails.org/latest`. This document specifically covers the basic building & installation of Grails from a source distribution. + +How to use the source distribution +------------------------------ +Grails is ultimately a set of libraries & Gradle build plugins that are used to create a Grails Application. Getting started with Grails requires knowing which libraries & which Gradle plugins to use. Since these dependencies will vary based on the application type, Grails also ships with a set of CLI commands to assist with application generation. Thus, the source distribution can be used to build & publish the code used by Grails applications. It can also be used to build the CLI commands that assist with application generation for that published code. + +Requirements & Tooling Setup for Building +------------------------------ +Grails requires a Java Development Kit (JDK) & Gradle (https://www.gradle.org) to build. Only specific versions are supported. A configuration file, `.sdkmanrc`, for SDKMAN! (https://sdkman.io/) exists in the source root to make it easier to setup the preferred tooling. This file contains the minimum versions to build Grails. + +If SDKMAN! is installed, the tooling can be selected by running the following command at the source root: + + sdk env install + +Otherwise, Gradle must be bootstrapped so that the correct version is used. The recommended way to do this is to use the Gradle Wrapper, which can be setup with files included in the source distribution. The wrapper will automatically download the correct version of Gradle specified in the `gradle/wrapper/gradle-wrapper.properties` file. To setup the wrapper, run the following commands: + + cd gradle-bootstrap + gradle bootstrap + +For the remaining commands in this document: `gradle` is used if tooling is installed with SDKMAN & `./gradlew` if the Gradle Wrapper is used. + +Requirements for Testing +------------------------------ +Grails has a comprehensive test suite that includes unit, integration, and functional tests. The functional tests use Testcontainers (https://www.testcontainers.org/), which requires a container runtime. In the event that a container runtime is not available, the tests can be skipped by using the argument the argument `-PskipTests`. Some container runtimes require more configuration than others. Please see the Testcontainers documentation at https://java.testcontainers.org/features/configuration/ for how to customize the container runtime used by Testcontainers. + +Project Structure +------------------------------ +The source of Grails is a multi-project Gradle build that uses composite multi-project builds via Gradle's includeBuild feature. The main project is `grails-core`, which contains the core framework code and all libraries that an end user would use in their application. The `grails-gradle` project contains code meant to run on the gradle build classpath. `grails-forge` contains tooling related to App Generation. + +Building grails-core +------------------------------ +To build libraries a Grails Application would use, run the following command at the source root: + + ./gradlew build -PskipTests + +This will build the project and skip any tests. + +Building grails-gradle +------------------------------ +To build libraries for the Gradle to use, run the following command under the `grails-gradle` directory: Review Comment: Suggestion: To build the libraries ... -- 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]
