ChopsUI: Update docs to include non-Web Component code as well.

Change-Id: I4d0b5ca624543b0b5a9faf409dde019d7c4ea4fe
Reviewed-on: https://chromium-review.googlesource.com/c/infra/infra/+/2729604
Auto-Submit: Tiffany Zhang <zhangtiff@chromium.org>
Reviewed-by: Dave Tu <dtu@chromium.org>
Commit-Queue: Dave Tu <dtu@chromium.org>
Cr-Commit-Position: refs/heads/master@{#38974}
GitOrigin-RevId: f3b66201e21383c6593809e0692e2fe4188a7480
1 file changed
tree: 71c943cd331e03319b56d2668a192c367ad5d6a0
  1. .eslintrc.json
  2. .gitignore
  3. README.md
  4. demos/
  5. elements/
  6. index.html
  7. karma-reporter/
  8. karma.conf.js
  9. lerna.json
  10. package-lock.json
  11. package.json
  12. test-helpers/
  13. tsconfig.build.json
  14. tsconfig.json
  15. tslint.json
  16. webpack.config.js
README.md

chopsui

This directory contains Web Components and JavaScript libraries shared across Chrome Operations' application frontends.

Using chopsui components

Find the name of the specific component and install it within the @chopsui package scope. For example, to install chops-header, run npm install @chopsui/chops-header.

Contributing

To set up project development:

  1. Clone this repo with git clone.
  2. Install dependencies with npm run bootstrap.
  3. Run tests with npm test.
  4. Run demos with npm start. The demos will be at http://localhost:8080/.

Publishing packages

ChopsUI packages are published publicly on npm under the @chopsui organization.

Each component is published under a separate npm package. Packages are managed using Lerna. All packages are published together using a single version number kept in the lerna.json file under the version key.

To set up:

  1. Send your npm username to zhangtiff@ to be added to @chopsui.
  2. Authenticate in npm with npm adduser.

To publish a new version:

  1. Sync a clean branch with upstream set to origin/master.
  2. Create a new version with npx lerna version --no-git-tag-version. Lerna will prompt you to select a new version number, detect which packages have changed since the last version, and locally update the json files.
  3. Commit the changes, upload them for code review, and land them.
  4. Sync to the newly landed commit.
  5. Publish to npm with npx lerna publish from-package.