44 lines
1.3 KiB
Markdown
44 lines
1.3 KiB
Markdown
# Git installation (SSH + tags)
|
|
|
|
This repository is consumed directly from Git tags, not from npm.
|
|
|
|
## Requirements
|
|
|
|
- You have SSH access to the repository (`git@github.com:ORG/REPO.git`).
|
|
- Release tags already exist in remote.
|
|
- `dist/` is committed in the tagged commit.
|
|
|
|
## Tag naming
|
|
|
|
Use package-specific tags:
|
|
|
|
- `tach-typography-vX.Y.Z`
|
|
- `video-player-vX.Y.Z`
|
|
- `content-suggestions-vX.Y.Z`
|
|
|
|
## Yarn template
|
|
|
|
Always wrap the dependency string in quotes because of `&tag=`.
|
|
|
|
```bash
|
|
yarn add "@hublib-web/<package>@git+ssh://git@github.com/ORG/REPO.git#workspace=@hublib-web/<package>&tag=<package>-vX.Y.Z"
|
|
```
|
|
|
|
## Package examples
|
|
|
|
```bash
|
|
yarn add "@hublib-web/tach-typography@git+ssh://git@github.com/ORG/REPO.git#workspace=@hublib-web/tach-typography&tag=tach-typography-v0.1.0"
|
|
yarn add "@hublib-web/video-player@git+ssh://git@github.com/ORG/REPO.git#workspace=@hublib-web/video-player&tag=video-player-v0.1.0"
|
|
yarn add "@hublib-web/content-suggestions@git+ssh://git@github.com/ORG/REPO.git#workspace=@hublib-web/content-suggestions&tag=content-suggestions-v0.1.0"
|
|
```
|
|
|
|
## Update package version in a consumer app
|
|
|
|
```bash
|
|
yarn up "@hublib-web/video-player@git+ssh://git@github.com/ORG/REPO.git#workspace=@hublib-web/video-player&tag=video-player-v0.2.0"
|
|
```
|
|
|
|
## Related docs
|
|
|
|
- Release policy: [release-policy.md](./release-policy.md)
|