careen's Introduction

Careen

Careen is a utility to clone repositories and apply patches to them. It does not aim to be a general artifact management system, just to create a consistent set of sources to build from.

Careen is also verb meaning to "turn (a ship) on its side for cleaning, caulking, or repair."

Usage

git clone https://github.com/samsung-cnct/careen.git
cd careen
go build
./careen help
./careen clone -c manifests/docker.yaml
./careen apply -c manifests/docker.yaml

Build instructions vary by package and are expected to be codified by a CI system. For examples, see here https://github.com/samsung-cnct/kraken-ci-jobs (not yet implemented).

Repository Patch Set Specification

Options

Root Options

Key Name	Required	Type	Description
version	Required	String	Version of the repository patch set
packages	Required	Object Array	Array of package

package options

Key Name	Required	Type	Description
name	Required	String	Name of package
repo	Required	String	URL of the repository
revision	Recommended	String	Commit hash from the repository
tag	Required	String	Tag in repository
patches	Optional	Object Array	Array of patch

patch options

Key Name	Required	Type	Description
name	Required	String	Name of patch
filename	Required	String	Filename of patch
hash	Required	String	SHA-1 hash of file referred to by filename
documentation	Optional	Object Array	Optional array of URLs to PR requests, bug reports, or other documentation

Example

---
version: 0.0.1
packages:
  - name: docker
    repo: "https://github.com/docker/docker.git"
    revision: "b9f10c951893f9a00865890a5232e85d770c1087"
    tag: "v1.11.2"
    patches:
      - name: "Add support for setting sysctls"
        filename: docker-19265.patch
        hash: "71705e0fa7d5dc0d9495ce692e7c9b95a8ddf9ff"
        documentation:
          - "https://github.com/docker/docker/pull/19265"

Recommend Projects