Trrack

Trrack stands for reproducible tracking. Originally Trrack is a web-based provenance tracking library that can track application state in directed provenance graph. The core library is framework-agnostic and can be used in any JavaScript/TypeScript application. The React visualization package provides components for rendering the provenance graph in a React application.

Table of Contents

• Packages
• Installation
• Quick Start
• Developer Docs
  • Development
  • Testing and Linting
  • Releasing

Packages

• @trrack/core Core action-based provenance tracking library.
• @trrack/vis-react React components for rendering a Trrack provenance graph.

Installation

Install the core package:

yarn add @trrack/core

Install the React visualization package with our peer dependencies:

yarn add react react-dom @trrack/core @trrack/vis-react

Quick Start

For core usage, start with our documentation.

Developer Docs

Development

Install dependencies:

yarn install

Run the example apps:

yarn dev:react
yarn dev:dummy
yarn dev:lineup
yarn dev:docs

Run all dev targets at once:

yarn dev

Testing and Linting

Build the published packages:

yarn build

Run package tests:

yarn test

Generate package coverage reports:

yarn test:coverage

Coverage reports are written to coverage/core and coverage/vis-react.

Run package linting:

yarn lint

Releasing

Packages are published from a GitHub Release via .github/workflows/build_test_release.yml.

Release flow:

1. Create a GitHub Release from the commit you want to publish.
2. Tag it as v<version> or v<version>-<prerelease>.
3. Mark prerelease releases as prereleases in GitHub.
4. Automatically generate release notes with the "Generate release notes" button in GitHub, or write your own release notes.
5. Publish the release.

The release workflow installs dependencies, builds and tests the packages, verifies package contents with npm pack --dry-run, and publishes both @trrack/core and @trrack/vis-react at the same version number.