/module-ballerina-xmldata

Ballerina xml utils Module

Primary LanguageBallerinaApache License 2.0Apache-2.0

Ballerina XmlData Library

Build codecov Trivy
GraalVM Check GitHub Last Commit Github issues

This library provides APIs to perform conversions between XML and JSON/Ballerina records. It provides APIs to get natural representations of data in XML from JSON and to get JSON or Ballerina records data from natural representations of data in XML.

Issues and projects

Issues and Project are disabled for this repository as this is part of the Ballerina Standard Library. To report bugs, request new features, start new discussions, view project boards, etc. please visit Ballerina Standard Library parent repository.

This repository only contains the source code for the package.

Build from the source

Set up the prerequisites

  1. Download and install Java SE Development Kit (JDK) version 11 (from one of the following locations).
    • Oracle

    • OpenJDK

      Note: Set the JAVA_HOME environment variable to the path name of the directory into which you installed JDK.

Build the source

Execute the commands below to build from source.

  1. To build the library:

     ./gradlew clean build
    
  2. To run the tests:

     ./gradlew clean test
    
  3. To build the package without tests:

     ./gradlew clean build -x test
    
  4. To run a group of tests:

     ./gradlew clean test -Pgroups=<test_group_names>
    
  5. To debug package implementation:

     ./gradlew clean build -Pdebug=<port>
    
  6. To debug the package with Ballerina language:

     ./gradlew clean build -PbalJavaDebug=<port>
    
  7. Publish ZIP artifact to the local .m2 repository:

     ./gradlew clean build publishToMavenLocal
    
  8. Publish the generated artifacts to the local Ballerina central repository:

     ./gradlew clean build -PpublishToLocalCentral=true
    
  9. Publish the generated artifacts to the Ballerina central repository:

     ./gradlew clean build -PpublishToCentral=true
    

Contribute to Ballerina

As an open source project, Ballerina welcomes contributions from the community.

For more information, go to the contribution guidelines.

Code of conduct

All contributors are encouraged to read the Ballerina Code of Conduct.

Useful links