Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 2.06 KB

README.md

File metadata and controls

68 lines (49 loc) · 2.06 KB

MonkeyPack

Build Status PyPI version codecov Code style: black Licence: MIT

A github release driven Package Manager for Connect IQ barrels

Usage

$ mbget update

Basics

Application Repository Configuration

The tool expects to find various files in the repository to determine where to get dependencies from. The only non-standard ConnectIQ project file introduced is a package map file (packages.txt)

project_root/
|-manifest.xml
|-packages.txt

Manifest File

No changes are required from the standard barrel dependency declarations that are required for barrels to be included in a project, but they are called out here to provide context for the package map file.

<iq:manifest xmlns:iq="http://www.garmin.com/xml/connectiq" version="3">
    <iq:application>
        <iq:products />
        <iq:permissions />
        <iq:languages />
        <iq:barrels>
            <iq:depends name="LibraryA" version="0.3.0"/>
            <iq:depends name="LibraryB" version="1.0.0"/>
        </iq:barrels>
    </iq:application>
</iq:manifest>

Package Map File

The package map file is a text file that is used to map manifest.xml dependencies onto github repositories that the dependency can be retrieved from.

LibraryA=>GitHubLibraryARepo
LibraryB=>GitHubLibraryBRepo

Library Repository Requirements

The tool expects that the libraries it downloads will make a new "Release" when a version is available. The library should use semantic versions when tagging releases.

The library must also include the barrel file in the release assets