Skip to content
This repository has been archived by the owner on Jul 17, 2023. It is now read-only.

Latest commit

 

History

History
122 lines (77 loc) · 3.21 KB

DEVELOPMENT.md

File metadata and controls

122 lines (77 loc) · 3.21 KB
Raw

Follow the steps below to set up the repository to be run locally.

The main branch is automatically deployed via Github Actions to pebble.istreamplanet.net.

Install the Packages

yarn

Start Development Server

yarn start

Run unit tests

yarn test

Run test coverage

Although not strictly enforced, we aim for 100% unit test coverage for each component.

yarn cover

Visual Regression Testing

Pebble uses Chromatic and Storybook for visual regression testing. Each push to the build service will run the Chromatic service. If there are visual changes detected in any component story, a maintainer will be required to review and approve/deny the difference in the Chromatic App.

To run Chromatic on a local build, get Pebble's Chromatic app code and run the following command.

yarn chromatic --app-code=<your-app-code>

For more information, see the Chromatic Documentation.

Otherwise, Chromatic will run automatically when you push to a remote branch.

Run Documentation Site (React Styleguidist)

yarn styleguide

Run Storybook Site

yarn storybook

Build Documentation Site

yarn styleguide:build

How to Release

Release an Update

Package releases should be done through the following commands:

Update your local checkout and make sure it is up to date

git fetch --tags
git checkout main
git pull origin main

release a patch update

npm version patch -m "release package %s because reasons"

release a minor update

npm version minor -m "release package %s because reasons"

or for an alpha pre-release minor update

npm version pre-minor -m "release package %s as alpha because reasons" --preid=alpha

The following will then happen

  • Execute a coverage test run to make sure everything is okay
  • Bump the version number in package.json accordingly (see examples)
  • Add a tag in git with that version number
  • Push to git origin including tags

From there the CI machine takes over and for every tagged commit the following happens

  • NPM publish is run, this in turn will trigger our prepack that cleans and builds the package
  • The newly minted package is published with the next tag. This is done to prevent prerelease packages from being installed by default.

Troubleshooting

If both the tag and branch fail to push, please open an issue requesting a new release be made.

If the tag is pushed up but the branch fails to push, please create a PR with the changes to keep them in sync.

If the branch is pushed up but the tag fails to push, this probably means the tag already existed.

Tag "latest" on npm

To promote the new package to the latest tag and make it the preferred default install:

  1. Log into with npm login [username]but if rumors are true, that could increase a lot in the future.
  2. Apply the latest tag npm dist-tag add @istreamplanet/pebble@[version number] latest