@thecb/components 3.1.10 → 3.3.0

package/README.md

@@ -13,10 +13,11 @@ This library contains Citybase React components for use across all current and f
   - [Version bumping](#version-bumping)
   - [Publishing new versions to NPM](#publishing-new-versions-to-npm)
 - [Consuming in your application](#consuming-in-your-application)
+
   - [Adding to existing application](#adding-to-existing-application)
   - [Local import and development](#local-import-and-development)
   - [Importing and using components](#importing-and-using-components)
-  
+
 <!-- /TOC -->
 
 ## Development setup
@@ -58,7 +59,7 @@ Please include new component stories as this library will also be a sandbox.
 
 - New components may be added to this library via pull request. Only components that are currently used in, or expected to be used in, more than one CB frontend should be present in this library. Very niche application specific components should be kept in the `components/atoms` and `components/molecules` directory of their parent application.
 
-- Almost all components in this library, and almost all newly added components, should be as "dumb" as possible. Ideally avoid introducing components that have tight integrations with application state. Forms and form components that make use of redux-freeform are an exception to this rule. 
+- Almost all components in this library, and almost all newly added components, should be as "dumb" as possible. Ideally avoid introducing components that have tight integrations with application state. Forms and form components that make use of redux-freeform are an exception to this rule.
 
 - If a non-form component contains integration with application state, or business logic specific to a particular application, breaking the component up into styled/layout atoms and an application specific molecule that consumes them is the best practice. An example of this can be observed with the `Header` and `Footer` molecules in Navigate Frontend. Both of these molcules make use of component library atoms such as `NavHeader` to layout out content. NFE then has `Header` and `Footer` molecules which live in the NFE components directory and use NFE specific business logic to provide content to these atoms, resulting in a complete `Header` and `Footer`.
 
@@ -78,7 +79,7 @@ Please include new component stories as this library will also be a sandbox.
 
 ### Publishing new versions to NPM
 
-- While GitHub will handle bumping the version of the library with every PR merge to master, publishing an update version of the library to NPM requires creating a release using the `release` script. This script triggers an action in the repo to create a release tagged with a publication date. After a new release is created, an action checks to see whether the library version differs from that on NPM. If the library version has changed, the action attempts to publish the new version to NPM.
+- While GitHub will handle bumping the version of the library with every PR merge to master, publishing an update version of the library to NPM requires creating a release using the `release` script. This script triggers an action in the repo to create a release tagged with a publication date. After a new release is created, manually run `yarn build && yarn publish` in your repo directory to publish a new version to NPM. When yarn asks you what version to publish, enter the same number that it gives you, as this number will already reflect the increase in version from the auto version bump action.
 
 - Once a new version of the library is published to NPM, you may either manually update your application's `package.json` to request that new version, or wait until the following morning when dependabot will pick up the change and create an update PR for you.
 
@@ -86,12 +87,12 @@ Please include new component stories as this library will also be a sandbox.
 
 ### Adding to existing application
 
-- Run `yarn add @thecb/components`. 
+- Run `yarn add @thecb/components`.
 - To verify it installed successfully, make sure it is in the applicaton's `package.json` file.
 
 ### Local import and development
 
-If you are developing locally, you can add or make changes to components in the `@thecb/components` package and see those changes in the application running locally by linking the `@thecb/components` package to your application. 
+If you are developing locally, you can add or make changes to components in the `@thecb/components` package and see those changes in the application running locally by linking the `@thecb/components` package to your application.
 Open the `@thecb/components`, and in the command line
 
 - Run `yarn build`
@@ -104,7 +105,7 @@ You should see a success message, and directions on how to link this package int
 Now the package is linked locally and you can make changes to the `@thecb/components` and you’ll see the changes in the application running `@thecb/components`. To unlink the package, in the application running `@thecb/components` and in the command line
 
 - Run `yarn unlink @thecb/components`
-- Run `yarn install` `--``force`
+- Run `yarn install` ` --``force `
 
 Next go to the `@thecb/components` and in the command line
 
@@ -116,9 +117,9 @@ Now the package is unlinked, and you’re using the version on NPM.
 
 To use components, you need to import the desired components inside the file you’d like them in. For example, to import the `<ButtonWithAction />` component into a file
 
-- `import { ButtonWithAction } from` `"``@thecb/components``"``;`
+- `import { ButtonWithAction } from` ` "``@thecb/components``"``; `
 
-You can alias the component by 
+You can alias the component by
 
 - `import { ButtonWithAction as MyButton } from "@thecb/components";`