External Timelines

Delphinus supports putting Delphinus-Related files into a seperated repository linking to the sourcerepository. This allows for simpler management of Delphinusfiles(like fixing bugs in Json afterwards) or linking your Delphinuspackage to a Bitbucketrepository which removes the need to mirror it to Github. At the same time this keeps your sourcerepository clean from these files.

Required Files

The repository you want to use for an external timeline needs to include thes files(and nothing more):

• Delphinus.Info.json
• Delphinus.Install.json
• Readme with the keyword Delphinus-Support(don't add this into the Readme of the linked repository!)
• Logo (if given in the info)

The licensefile(if given) is pulled from the linked repository using the relative path given in the Info.

Delphinus.Info.json

The infofile needs an extra entry to link to the repository. In addition to your existing info, add this:

{    
  ...    
  "repository":    
  {    
    "type": "Bitbucket",
    "user": "myusername",
    "name": "repositoryname"
    "redirect_issues": true //this is the default if not specified!
  }     
}    

type:
Specifies the repositorytype to link to. You can either specify "Bitbucket" or "Github".
user:
The username of the repository to link to. Only lowercase letters.
name:
The name of the repository to link to. Only lowercase letters.
redirect_issues:
(Optional) Default=True
If this is true and the Infofile does not specify a custom report_url, the package will redirect to the linked repositories issue-tracker when clicking on the reportbutton in Delphinus. It is expected that the issue-tracker is enabled. Disable redirection if otherwhise.

Versioning and HEAD

To add versions to this Delphinuspackage, you create releases as usual. But the tag of each release MUST correspond(means exact equal name) to a tag in the linked repo. Delphinus will try to download the linked repository at this tag when installing.
If Delphinus is instructed to install unversioned(in this case from HEAD), the defaultbranch of the DelphinusPackage-Repo is used to download from the linked repository.