Adding LaunchBase Metadata to your Branch

Adding LaunchBase Metadata to your Branch

In order for LaunchBase to automatically offer your branch for download and to properly notice when updates are available, your branch needs to provide metadata about itself.

How-to

The metadata is saved in a file called .branchinfo (note the leading period) saved directly in the root of your branch. The contents of this file are INI-file-esque:

[branch]
Name=
Description=
BranchRevision=
TargetVersion=
Stable=
ReadyForTesting=

[branch]

This stays as displayed.

Name=

This is the name of your branch.

Description=

A description of what this branch contains, especially differences to master/stable.

BranchRevision=

Simple integer. Increase this number whenever you'd like LaunchBase to offer an update of your branch.

TargetVersion=

The Ares version this feature is planned to end up in.

Stable=

yes or no; whether this branch is stable. This should never be yes for feature- or other implementation branches. This is a special case for backport and series branches.

ReadyForTesting=

yes or no; whether this branch is ready for testing.

Example

[branch]
Name=Carryall Fixes
Description=Branch for developing Carryall logic fixes
BranchRevision=12
TargetVersion=0.2
Stable=no
ReadyForTesting=yes

Template

[branch]
Name=
Description=
BranchRevision=1
TargetVersion=0.
Stable=no
ReadyForTesting=no

Download Location

There are two ways to provide the binary data for your branch:

1. Upload it: [to be filled with upload info]
2. Provide the URL= option in your .branchinfo, followed by the complete URL to a direct download of your branch's binary data. The file must have the following properties: [list to be filled in]