Skip to content

Recidiviz/web-libraries

Folders and files

NameName
Last commit message
Last commit date
Nov 2, 2023
May 5, 2022
Feb 12, 2025
Aug 25, 2021
Mar 20, 2023
Apr 7, 2021
Apr 7, 2021
Apr 6, 2021
Aug 25, 2021
May 18, 2021
Nov 21, 2024

Repository files navigation

Recidiviz Web Libraries

Packages shared across the Recidiviz web platform.

This is a multi-package repository. The individual packages (found in packages/*) have their own README files with more detailed information about their use.

Packages in this repository

All npm packages should be scoped to the @recidiviz organization.

@recidiviz/design-system

@recidiviz/eslint-config

@recidiviz/tsconfig

Development

Packages are versioned independently of one another and have separate dependencies. Dependencies are managed with yarn. For convenience, a postinstall script will install dependencies for all packages when you run yarn install in the root package.

Releasing packages

The release process is semi-automated and relies on Github Actions. When you are ready to release a package, you should perform the following steps:

  1. Increment the version number in the package.json, following semantic versioning conventions. Update the CHANGELOG.md for the package you are updating.
  2. Open a pull request to update the package.json,
  3. Once that pull request is merged, create a Github Release on main for that package. Include a changelog in the body of the Release. The tag for this release must follow the naming convention [package]@[version-number], where package matches the name of the package's directory (e.g., eslint-config for packages/eslint-config). The version number should also match the version bump you just merged.
  4. When that release is created, the package matching the tagged name will be published to npm by a Github Action.