You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DEVELOPING.md
+7-10
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,19 @@
1
1
# Documentation for Developers
2
2
3
-
This document describes how to set up and develop native-build-tools on your local machine.
3
+
This document describes how to set up and develop Native Build Tools on your local machine.
4
4
5
5
## Environment
6
6
7
7
The project uses Gradle as its build system. At the very minimum, you should set `JAVA_HOME` to a [Gradle-compatible JDK](https://docs.gradle.org/current/userguide/compatibility.html).
8
8
9
9
Some build tasks require a GraalVM JDK (e.g., tests). You should set `GRAALVM_HOME` to an appropriate GraalVM JDK.
10
10
11
-
## IDE setup
11
+
## IDE Setup
12
12
13
-
The native-build-tools repo is set up as a multi-project Gradle project, with the Maven and Gradle plugins declared as subprojects of the root project.
13
+
The Native Build Tools repo is set up as a multi-project Gradle project, with the Maven and Gradle plugins declared as subprojects of the root project.
14
14
To set the project up in your IDE (e.g., IntelliJ IDEA), import the root project and the IDE should automatically import the subprojects.
15
15
16
-
## Building & testing
16
+
## Building and Testing
17
17
18
18
You can use the various commands in the [Gradle build lifecycle](https://docs.gradle.org/current/userguide/build_lifecycle.html) to build and test the project.
19
19
Some examples (all executed from the root of the repository):
@@ -30,7 +30,7 @@ Some examples (all executed from the root of the repository):
30
30
```
31
31
32
32
33
-
## Debugging plugin(s)
33
+
## Debugging Plugin(s)
34
34
It is often useful to attach a debugger to the Gradle and Maven plugins during a project build.
35
35
36
36
For the Gradle plugin, this can be accomplished by passing debugger options to the Gradle daemon via `org.gradle.jvmargs`, for example:
@@ -43,7 +43,7 @@ The Gradle daemon will suspend on start-up, wait for you to attach a debugger, a
43
43
44
44
For the Maven plugin, simply use the `mvnDebug` command in place of the `mvn` command.
45
45
46
-
## Testing local changes with an existing project
46
+
## Testing Local Changes with an Existing Project
47
47
A common development task is to modify a plugin and then test it with an existing project.
48
48
49
49
To do this, first modify the project as necessary, and then build and publish the plugins to the local Maven repository:
@@ -85,7 +85,4 @@ For Maven, simply bump the version and it should try the local repository automa
0 commit comments