Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 3.19 KB

README.md

File metadata and controls

65 lines (44 loc) · 3.19 KB
Raw

@rbflabs/agoric-react-components Monorepo

This monorepo contains:

Getting started

  • git clone https://github.com/RBFLabs/agoric-react-components.git
  • cd agoric-react-components
  • Run the Demo App - instructions here
  • For components reference go here

Useful Commands

  • yarn build - Build all packages
  • yarn dev - Run all packages locally
  • yarn lint - Lint all packages
  • yarn changeset - Generate a changeset
  • yarn clean - Clean up all node_modules and dist folders (runs each package's clean script)

Versioning & Publishing Packages

This repo uses Changesets to manage versions, create changelogs, and publish to npm. It's preconfigured so you can start publishing packages immediatley.

You'll need to create an NPM_TOKEN and GITHUB_TOKEN and add it to your GitHub repository settings to enable access to npm. It's also worth installing the Changesets bot on your repository.

Generating the Changelog

To generate your changelog, run yarn changeset locally:

  1. Which packages would you like to include? – This shows which packages and changed and which have remained the same. By default, no packages are included. Press space to select the packages you want to include in the changeset.
  2. Which packages should have a major bump? – Press space to select the packages you want to bump versions for.
  3. If doing the first major version, confirm you want to release.
  4. Write a summary for the changes.
  5. Confirm the changeset looks as expected.
  6. A new Markdown file will be created in the changeset folder with the summary and a list of the packages included.

Releasing

When you push your code to GitHub, the GitHub Action will run the release script defined in the root package.json:

turbo run build --filter=docs^... && changeset publish

Turborepo runs the build script for all publishable packages (excluding docs) and publishes the packages to npm. By default, this example includes acme as the npm organization. To change this, do the following:

  • Rename folders in packages/* to replace acme with your desired scope
  • Search and replace acme with your desired scope
  • Re-run yarn install

To publish packages to a private npm organization scope, remove the following from each of the package.json's

- "publishConfig": {
-  "access": "public"
- },

Contributing

If you are about to contribute to this project for the very first time, make sure to read the contributing guidelines. You will make it easier for both yourself and maintainers of this project.