61 lines
1.7 KiB
Markdown
61 lines
1.7 KiB
Markdown
# hublib-web
|
|
|
|
Monorepo for shared UI packages distributed with Yarn workspaces.
|
|
|
|
External projects install these packages directly from Git tags. Package `dist/` artifacts must be committed.
|
|
|
|
## Structure
|
|
|
|
- `packages/tach-typography` - typography tokens and adapters for React/Angular.
|
|
- `packages/video-player` - cross-framework video player runtime and adapters.
|
|
- `packages/content-suggestions` - content text/title with mention/tag/link parsing for React/Angular.
|
|
|
|
## Package READMEs
|
|
|
|
- [tach-typography](./packages/tach-typography/README.md)
|
|
- [video-player](./packages/video-player/README.md)
|
|
- [content-suggestions](./packages/content-suggestions/README.md)
|
|
|
|
## Development
|
|
|
|
```bash
|
|
corepack enable
|
|
yarn set version 4.12.0
|
|
yarn install
|
|
yarn build
|
|
yarn test
|
|
```
|
|
|
|
## Add a new package
|
|
|
|
1. Create a folder inside `packages/<name>`.
|
|
2. Add `package.json` with a unique package name.
|
|
3. Link internal dependencies with `workspace:*` (or `workspace:^`).
|
|
4. Run `yarn install` and then `yarn build`.
|
|
|
|
## Installation from Git (SSH)
|
|
|
|
This repository is consumed by tag-based Git dependencies.
|
|
|
|
- Full install guide: [docs/git-installation.md](./docs/git-installation.md)
|
|
- Release workflow: [docs/release-policy.md](./docs/release-policy.md)
|
|
|
|
Command template:
|
|
|
|
```bash
|
|
yarn add "@hublib-web/<package>@git+ssh://git@github.com/ORG/REPO.git#workspace=@hublib-web/<package>&tag=<package>-vX.Y.Z"
|
|
```
|
|
|
|
## Releases
|
|
|
|
Releases are done with Git tags (no Changesets, no npm publish).
|
|
|
|
Short flow:
|
|
|
|
1. Bump version in `packages/<package>/package.json`.
|
|
2. Build package and commit updated `dist/` artifacts.
|
|
3. Create an annotated package tag: `<package>-vX.Y.Z`.
|
|
4. Push commit and tags to origin.
|
|
|
|
Detailed policy and examples: [docs/release-policy.md](./docs/release-policy.md).
|