Files
_hublib-web/README.md

61 lines
1.7 KiB
Markdown
Raw Permalink Normal View History

# hublib-web
2026-02-25 16:21:13 +00:00
Monorepo for shared UI packages distributed with Yarn workspaces.
2026-02-27 09:50:13 +03:00
External projects install these packages directly from Git tags. Package `dist/` artifacts must be committed.
2026-02-27 09:50:13 +03:00
## Structure
2026-02-27 09:50:13 +03:00
- `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.
2026-02-27 09:50:13 +03:00
## Package READMEs
2026-02-27 09:50:13 +03:00
- [tach-typography](./packages/tach-typography/README.md)
- [video-player](./packages/video-player/README.md)
- [content-suggestions](./packages/content-suggestions/README.md)
2026-02-27 09:50:13 +03:00
## Development
2026-02-27 09:50:13 +03:00
```bash
corepack enable
yarn set version 4.12.0
yarn install
yarn build
yarn test
2026-02-27 09:50:13 +03:00
```
## Add a new package
2026-02-27 09:50:13 +03:00
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`.
2026-02-27 09:50:13 +03:00
## Installation from Git (SSH)
2026-02-27 09:50:13 +03:00
This repository is consumed by tag-based Git dependencies.
2026-02-27 09:50:13 +03:00
- Full install guide: [docs/git-installation.md](./docs/git-installation.md)
- Release workflow: [docs/release-policy.md](./docs/release-policy.md)
2026-02-27 09:50:13 +03:00
Command template:
2026-02-27 09:50:13 +03:00
```bash
yarn add "@hublib-web/<package>@git+ssh://git@github.com/ORG/REPO.git#workspace=@hublib-web/<package>&tag=<package>-vX.Y.Z"
2026-02-27 09:50:13 +03:00
```
## Releases
2026-02-27 09:50:13 +03:00
Releases are done with Git tags (no Changesets, no npm publish).
2026-02-27 09:50:13 +03:00
Short flow:
2026-02-27 09:50:13 +03:00
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.
2026-02-27 09:50:13 +03:00
Detailed policy and examples: [docs/release-policy.md](./docs/release-policy.md).