tmbuild package json Reference

The tmbuild can package a project based on rules set in a .json file. This file needs to adhere to the scheme described here. Every package json file is structured in its core like this:

{
    "name":"package name",
    "steps": []
}

The name will be used to determine the name of the package folder in tm root/build directory. The steps are the key in the system. They will be executed linearly after each other and the next step will only be executed if the previous step was successful. Steps are defined as a normal json object. The following list displays all the functions which can be used plus adequate examples.

Table of Content

• Utilities
  • Logging
  • Change directory
  • Platforms
• Actions
• Filesystem operations
  • build
  • copy-files
  • copy-file-patterns
  • delete-dirs
  • delete-file-patterns
  • docgen
  • localize
  • set-sdk-dir
  • zip
  • test
  • clean

Utilities

Logging

Example

{
    "name":"example-plugin",
    "steps": [
    {
        "log":"Example Plugin"
    }
    ]
}

Change directory

Example

{
    "name":"example-plugin",
    "steps": [
    {
        "log":"change dir",
        "chdir":"utils"
    }
    ]
}

Platforms

{
   "action":"delete-dirs",
   "root":"build/tmbuild/",
   "dirs":[
      "vs2017"
   ],
   "platforms":[
      "windows"
   ]
}

Actions

An action defines what the current step shall do.

Filesystem operations

build

Will build the current directory unless changed via chdir in release and debug settings. Optionally it has a project field if you only want to build one project. One can also modify the build tool and specify that in an extra field.

{
   "log":"Build Lib",
   "action":"build",
   "project":"lib_static",
   "build-tool":"vs2017",
   "platforms":[
      "windows"
   ]
}

copy-files

Will copy files which are specified in a files field. Also the location is needed to where those files should be copied. This location needs to be specified in the fieldto-dir

copy-file-patterns

Will copy files based on file patterns to a set location.

{
   "action":"copy-file-patterns",
   "from-dir":"plugins/my-plugin",
   "to-dir":"dest/folder/plugins/my-plugin",
   "dir-patterns":[
      "*"
   ],
   "file-patterns":[
      "*.c",
      "*.h",
      "*.inl"
   ]
}

delete-dirs

Will delete folders which are specified in dirs but taking the root field into account.

delete-file-patterns

Will delete files based on a pattern.

{
   "action":"delete-file-patterns",
   "dir":"bin/plugins",
   "dir-patterns":[
      "*"
   ],
   "file-patterns":[
      "*.pdb",
      "*.lib",
      "*.exp"
   ]
},

docgen

Will generate documentation based on the provided arguments in the arguments field.

localize

Will check if all localizations are present if not fail.

set-sdk-dir

Will set the SDK if not set dir to the current build directory [cwd]/build/[package-name]. Has no other fields.

zip

Will zip the package folder and if the field add-time-stamp is set to true it will add the time stamp to the name of the zipped file.

test

Will execute tests defined in the tests field.

clean

Will call the --clean command on tmbuild.