A common configs and conventions for Untile projects.

Setup

This project uses yarn workspaces to manage multiple packages.

Install dependencies

yarn

Run lint

yarn lint

Run full test suite

yarn test

Adding new packages

To ensure that every part of the monorepo infrastructure works as intended, every package must be located within the ./packages/<new-package-name> folder.

Release setup

After creating a package, add a release script to the ./packages/<new-package-name>/package.json file, and another one to the main ./package.json file with:

  "release:<new-package-name>": "yarn workspace @untile/<new-package-name> release",

Changelog setup

When creating new packages, keep in mind that the auto labeler must have the new package added in .github/labeler, so that it can label its pull requests accordingly and they are included in the correct CHANGELOG.md. To add new packages to auto labeler run:

sh bin/auto-labeler.sh

Release & Publish

Make sure that you have configured GITHUB_TOKEN in your globals. This will also publish your packages that have changes to NPM.

yarn release:[<package-name>] [<new version> | major | minor | patch]
git push origin master && git push --tags