@balena/release-bundle

Release Bundle SDK

A Release Bundle is a resource bundle that contains application release metadata and image layers.

Installing

npm install --save @balena/release-bundle

Usage

Creating a Release Bundle from a Fleet Release

import { writeFile } from 'fs/promises';
import { create } from '@balena/release-bundle';
import { getSdk } from 'balena-sdk';


async function run() {
    const sdk = getSdk();

    const releaseBundle = await create({
        sdk,
        releaseId: 3023927,
    });
    await writeFile('./release-bundle.tar', releaseBundle);

}

run();

Applying a Release Bundle to a Fleet

import { createReadStream } from 'fs';
import { apply } from '@balena/release-bundle';
import { getSdk } from 'balena-sdk';

async function run() {
    const sdk = getSdk();

    const bundle = await createReadStream(
        './release-bundle.tar',
    );

    await apply({
        sdk,
        application: 2136996,
        stream: bundle,
    });

}

run();

License

This project is distributed under the Apache 2.0 license.

Copyright (c) 2024 Balena Ltd.

Changelog

v0.5.2

(2024-08-30)

• Reinstate successful commit constraint. [Carlo Miguel F. Cruz]