@kbrain-rfp/components NPM

rfp-components

This library packages the components for the RFP project.

Development

All codes for the components are found in the src folder.

Tests

Tests are located in the src/__tests__ folder and usually have the spec.tsx prefix. Test cases are written using the jest framework and can be run by issuing the command npm run-script test.

Storybook

This package is configured with storybook. You can type npm run-script storybook to launch it. This will automatically spin up a browser window for you to inspect the components. See more at Storybook's Official Website.

Publishing

The azure-pipelines.yml contains instructions and triggers for the build pipeline.

To setup the release pipeline, go to Azure DevOps and import the rfp-components Release.json. This only needs to be done once.

Create a new branch (anything other than main) and make your changes there. When ready, push your changes up to Azure DevOps with git, and then create a pull request targeting the main branch. (Note - never increment the package.json version number. This is done by the build pipeline). A build and release will automatically be triggered. The package patch version will automatically be incremented (if there is no pre-release version) and the suffix pr-# will be added to the package version. The # of the pre release depends on the number of PRs opened for this patch version.

This pre release version will automatically be deployed to the package registry. Once the PR has been merged into master, the pre-release version will be dropped and the release version will be published into npm. These versions will automatically be tagged and pushed via git into the repository. Don't forget to pull the latest or you will experience merge conflicts.

You can manually publish from the command line by running npm run-scripts build and npm run-scripts publish.

The storybook build will automatically be published into Chromatic. The Chromatic URL can be used to browse the components in Storybook and also for manual review checks.

Pull requests

The main branch should be configured as the default branch and branching policies should be configured within Azure DevOps to prevent pushes to this branch without at least 1 reviewer.