Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add build and debug instructions to the ballerina gradle plugin #170

Merged
merged 1 commit into from
Aug 23, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,39 @@ The Ballerina Gradle plugin is used to build Ballerina modules using Gradle. Thi
testCoverageParam = "--code-coverage --coverage-format=xml"
}
```

## Build from the source

Download and install Java SE Development Kit (JDK) version 17. You can download it from either of the following sources:

* [Oracle JDK](https://www.oracle.com/java/technologies/downloads/)
* [OpenJDK](https://adoptium.net/)

> **Note:** After installation, remember to set the `JAVA_HOME` environment variable to the directory where JDK was installed.

### Build options

Execute the commands below to build from the source.

1. To build the package:

```bash
./gradlew clean build
```

2. To publish to maven local:

```bash
./gradlew clean build publishToMavenLocal
```

### Debug options

To debug the Ballerina gradle plugin against a Ballerina library package build use the following command to build the library:

```bash
./gradlew clean build -Dorg.gradle.debug=true
```

This would start a debug process on port `5005` and the developer can configure the remote debug for the Ballerina
gradle plugin for this port.
Loading