7.0.11 • Published 8 months ago

@quick-hjk/apply-release-plan v7.0.11

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

Apply Release Plan

npm package View changelog

This takes a releasePlan object for changesets and applies the expected changes from that release. This includes updating package versions, and updating changelogs.

import applyReleasePlan from "@quick-hjk/apply-release-plan";
import { ReleasePlan, Config } from "@quick-hjk/types";
import { Packages } from '@manypkg/get-packages'

await applyReleasePlan(
    // The release plan to be applied - see @quick-hjk/types for information about its shape
    aReleasePlan: ReleasePlan,
    // The packages that applyReleasePlan should be run for from @manypkg/get-packages
    packages: Packages,
    // A valid @quick-hjk/config config - see @quick-hjk/types for information about its shape
    config: Config
);

Note that apply-release-plan does not validate the release plan's accuracy.

To generate a release plan from written changesets use @quick-hjk/get-release-plan