Contains the source code for Block Protocol development libraries and utilities, as well as plugins. Full write-ups of most can be found either in README.md files in each individual library folder or in the Block Protocol docs, and a summary table will shortly be published below.
All libraries except those in @local/ are published to npm via
Changesets.
To record a change for publication:
- From the root of the repository, run
yarn changeset - Select the package(s) affected by this change (space to select, enter to move to the next step)
- Do not worry about selecting packages which depend on changed packages – Changesets will handle bumping them
- Select the semver increment
- Describe the change
- Commit the created changeset file
When a PR with a changeset file is merged, the change is added to a PR entitled 'Version Packages', which has a diff showing the version increments which will be applied to affected packages, including dependents.
Once the 'Version Packages' PR is merged, the changes are published to npm.
Canary versions can be published by running the Canary Release workflow in GitHub Actions, and selecting the branch which contains changesets to publish.