Skip to content

Commit

Permalink
update snapshot size file and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
daigof committed Oct 8, 2020
1 parent b17a10f commit 3177846
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 19 deletions.
24 changes: 12 additions & 12 deletions .size-snapshot.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"bundle.js": {
"bundled": 1129508,
"minified": 1067744,
"gzipped": 104557
"bundled": 1128786,
"minified": 1067488,
"gzipped": 104477
},
"bundle.umd.js": {
"bundled": 1139116,
"minified": 1041186,
"gzipped": 100140
"bundled": 1138366,
"minified": 1040966,
"gzipped": 100065
},
"shared-components/chip/index.js": {
"bundled": 576,
Expand Down Expand Up @@ -472,16 +472,16 @@
}
},
"shared-components/dialogModal/index.js": {
"bundled": 4359,
"minified": 2516,
"gzipped": 1069,
"bundled": 3604,
"minified": 2220,
"gzipped": 984,
"treeshaked": {
"rollup": {
"code": 2094,
"import_statements": 532
"code": 1847,
"import_statements": 513
},
"webpack": {
"code": 3461
"code": 3179
}
}
},
Expand Down
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# CHANGELOG

# v12.1.0

- [Internal] TypeScript conversion: VerificationMessages, Field

# v12.0.0

- [API] **BREAKING**: Removes `BOX_SHADOWS.focusSecondary`. Please replace usage with with `BOX_SHADOWS.focus`. ([#400](https://github.com/curology/radiance-ui/pull/400))
Expand Down
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
# ✨ Radiance UI

[![CircleCI](https://circleci.com/gh/PocketDerm/radiance-ui.svg?style=svg)](https://circleci.com/gh/PocketDerm/radiance-ui)

Curology's React based component library

## Storybook

Radiance UI has a built in storybook. Every time a new commit is made to
master, it is automatically deployed to
[https://radiance-ui.curology.com](https://radiance-ui.curology.com).

To run Storybook locally, use `yarn run storybook`.

## Contributing

To contribute to Radiance UI, please create a PR with the following in
the appropriate places:

Expand All @@ -19,31 +22,36 @@ the appropriate places:
- A storybook story

## Tests
Tests can be run with `yarn run test`. Radiance uses Jest + Enzyme.

Tests can be run with `yarn run test`. Radiance uses Jest + Enzyme.

## Local Development Setup

If you want to test out your changes with another repo that uses
Radiance, we recommend using the `link` feature with [npm](https://docs.npmjs.com/cli/link)
or [yarn](https://yarnpkg.com/lang/en/docs/cli/link/).

## Documentation

Documentation around usage, you can also see it with knobs at: [https://radiance-ui.curology.com](https://radiance-ui.curology.com)

- [Alert](docs/alert.md)
- [Constants](docs/constants.md)
- [Icon](docs/icon.md)
- [Typography](docs/typography.md)
- [Typography Style](docs/typography-style.md)

## Publishing to NPM

You'll need access to publish to NPM so this part only applies to a few
people (mostly within the Curology organization). Once approved, merge your PR(s) into master and follow these steps:

1. Pull latest master and check out the master branch.
2. Commit an update to the CHANGELOG.md file with details.
3. Run `yarn run publish-package` to build the bundled files and publish
1. Run `yarn build` and commit the `.size-snapshot.json` change either as part of your PR or as part of the CHANGELOG.md change below
2. Pull latest master and check out the master branch.
3. Commit an update to the CHANGELOG.md file with details.
4. Run `yarn run publish-package` to build the bundled files and publish
to NPM.
4. Push changes made to `package.json` to remote repository
5. On GitHub, tag a release with the proper version and details. You can
5. Push changes made to `package.json` to remote repository
6. On GitHub, tag a release with the proper version and details. You can
do that
[here](https://github.com/PocketDerm/radiance-ui/releases/new).
[here](https://github.com/PocketDerm/radiance-ui/releases/new).

0 comments on commit 3177846

Please sign in to comment.