Introduction

When changing the contents of a Jallib release, the following files must be updated in the root directory of Jallib on GitHub:

• The file TORELEASE describing which files are part of the Jallib release
• The file CHANGELOG describing the changes of the Jallib release

Prerequisites

When adding libraries and/or sample files to a Jallib release you must be sure that all files comply the Jallib style guide and that all files compile without any warnings and errors. Compliance with the style guide can be verified by running the jallib3.py Python script.

You can check one file using the command python jallib3.py validate myfile.jal or check all your files in the same directory using *.jal as parameter, as follows:

Before you can add any files to Jallib you need to install GitHub on your computer or you can use GitHub Desktop. All JAL sample files and libraries must be uploaded to Jallib on GitHub. There you find a directory structure. In most cases the following directories are used:

• sample for your sample files
• include for your library files. There are sub directories in this directory. See if your library fits in one of the existing sub directories. If not, create a new sub directory for your library files.

Updating the file TORELEASE

Not all files that are on GitHub are part of a Jallib release. In order to add your files to the upcoming Jallib release you have to add all uploaded files from the previous section to the TORELEASE file. This is a text file in which you have to add your new files using the correct file location used on GitHub. Make sure to add the files in alphabetic order.

You can, or course, also remove files from the Jallib release but that will not happen very often.

Updating the file CHANGELOG

This text file describes the changes of each Jallib release. Changes can, for example, be new libraries, new sample files, new device files or changes to existing files like bug fixes or additions.

Creating a new Jallib build

After having added all your sample files, library files and updated the files TORELEASE and CHANGELOG you can commit your changes to GitHub. After your commit, a build will automatically be started on the Jallib server where all sample files in the TORELEASE folder are validated and compiled. The result of the build is sent to the Jallib Google Group¹. When an error occurs in making a new build you have to fix the error as soon as possible and upload your fixes.

If all goes well you did a great job and you made the next Jallib release richer!