# ReleaseKit v0.3.0 - Table of Contents

> Build OTP release tarballs with deployment-neutral artifact manifests

## Pages

- [ReleaseKit](readme.md)
- [Changelog](changelog.md)

## Modules

- [ReleaseKit](ReleaseKit.md): Builds plain OTP release artifacts for deployment tools.
- [ReleaseKit.Artifact](ReleaseKit.Artifact.md): File operations for release artifact tarballs.

- [ReleaseKit.ArtifactInfo](ReleaseKit.ArtifactInfo.md): Metadata about a packaged release artifact.

- [ReleaseKit.Asset](ReleaseKit.Asset.md): Runs first-class frontend asset build presets before packaging a release.

- [ReleaseKit.AssetInfo](ReleaseKit.AssetInfo.md): Metadata about frontend assets built into a release artifact.

- [ReleaseKit.BuildInfo](ReleaseKit.BuildInfo.md): Records build-tool and source-control metadata for an artifact.

- [ReleaseKit.Builder](ReleaseKit.Builder.md): Orchestrates Mix release artifact builds.

- [ReleaseKit.Checksum](ReleaseKit.Checksum.md): Computes and writes checksums for release artifacts.

- [ReleaseKit.Compile](ReleaseKit.Compile.md): Converts ReleaseKit compile configuration into Mix compiler behavior.
- [ReleaseKit.Config](ReleaseKit.Config.md): Validates ReleaseKit artifact configuration before a build starts.

- [ReleaseKit.Lifecycle](ReleaseKit.Lifecycle.md): Runs configured lifecycle steps around release artifact assembly.

- [ReleaseKit.Manifest](ReleaseKit.Manifest.md): Manifest describing a built OTP release artifact.
- [ReleaseKit.Package](ReleaseKit.Package.md): Normalizes package policy options for artifact tarballs.

- [ReleaseKit.PackageBuilder](ReleaseKit.PackageBuilder.md): Packages a Mix release directory into a ReleaseKit artifact.

- [ReleaseKit.PackageCache](ReleaseKit.PackageCache.md): Tracks package inputs so unchanged release directories can reuse artifacts.
- [ReleaseKit.PackageCache.Entry](ReleaseKit.PackageCache.Entry.md): Cached metadata for one release file used by `ReleaseKit.PackageCache`.

- [ReleaseKit.Step](ReleaseKit.Step.md): Runs application-owned build steps before an OTP release artifact is assembled.
- [ReleaseKit.Target](ReleaseKit.Target.md): Describes the platform an artifact was built for.
- [ReleaseKit.Telemetry](ReleaseKit.Telemetry.md): Emits and summarizes ReleaseKit artifact build telemetry.
- [ReleaseKit.Volt](ReleaseKit.Volt.md): Builds Volt asset preset arguments and metadata.

## Mix Tasks

- [mix release_kit.artifact](Mix.Tasks.ReleaseKit.Artifact.md): Builds an OTP release tarball and ReleaseKit ETF manifest.

