Home

Awesome

copybook-tools

Build codecov GitHub Last Commit Github issues

The Copybook tool simplifies the process of transforming Copybook definitions into Ballerina code.

Command for Ballerina Copybook type generation

ArgumentDescription
-i, --inputThe input parameter specifies the path of the Copybook definition file (e.g., Copybook.cpy). This parameter is mandatory.
-o, --outputThe output parameter specifies the path of the output location of the generated Ballerina type file. This parameter is optional. If this parameter is not specified, the service files will be generated at the same location from which the Copybook command is executed.

Building from the Source

Setting Up the Prerequisites

  1. Download and install Java SE Development Kit (JDK) version 21. You can install either OpenJDK or Oracle.

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

  2. Export GitHub Personal access token with read package permissions as follows,

    export packageUser=<Username>
export packagePAT=<Personal access token>

Building the Source

Execute the commands below to build from the source.

  1. To build the library:

     ./gradlew clean build

  2. To run the integration tests:

     ./gradlew clean test

  3. To build the module without the tests:

     ./gradlew clean build -x test

Contributing 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