23059a1de3
Some checks failed
CodeQL / Analyze (javascript) (push) Failing after 16s
CodeQL / Analyze (python) (push) Failing after 3s
i18n sync check / check:sync (push) Failing after 3s
React Doctor / react-doctor (push) Failing after 16s
Branch Build CE / Build-Push Admin Docker Image (${{ matrix.arch }}) (push) Has been cancelled
Branch Build CE / Merge Admin Manifest (push) Has been cancelled
Branch Build CE / Build-Push Web Docker Image (${{ matrix.arch }}) (push) Has been cancelled
Branch Build CE / Merge Web Manifest (push) Has been cancelled
Branch Build CE / Build-Push Space Docker Image (${{ matrix.arch }}) (push) Has been cancelled
Branch Build CE / Merge Proxy Manifest (push) Has been cancelled
Branch Build CE / Merge Space Manifest (push) Has been cancelled
Branch Build CE / Prepare AIO Assets (push) Has been cancelled
Branch Build CE / Build Setup (push) Has been cancelled
Branch Build CE / Build-Push Live Collaboration Docker Image (${{ matrix.arch }}) (push) Has been cancelled
Branch Build CE / Merge Live Collaboration Manifest (push) Has been cancelled
Branch Build CE / Build-Push API Server Docker Image (${{ matrix.arch }}) (push) Has been cancelled
Branch Build CE / Merge API Server Manifest (push) Has been cancelled
Branch Build CE / Build-Push Proxy Docker Image (${{ matrix.arch }}) (push) Has been cancelled
Branch Build CE / Build-Push AIO Docker Image (${{ matrix.arch }}) (push) Has been cancelled
Branch Build CE / Merge AIO Manifest (push) Has been cancelled
Branch Build CE / Upload Build Assets (push) Has been cancelled
Branch Build CE / Build Release (push) Has been cancelled
49 lines
1.2 KiB
Markdown
49 lines
1.2 KiB
Markdown
---
|
|
description: Guidelines for bash commands and tooling in the monorepo
|
|
applyTo: "**/*.sh"
|
|
---
|
|
|
|
# Bash & Tooling Instructions
|
|
|
|
This document outlines the standard tools and commands used in this monorepo.
|
|
|
|
## Package Manager
|
|
|
|
We use **pnpm** for package management.
|
|
- **Do not use `npm` or `yarn`.**
|
|
- Lockfile: `pnpm-lock.yaml`
|
|
- Workspace configuration: `pnpm-workspace.yaml`
|
|
|
|
### Common Commands
|
|
- Install dependencies: `pnpm install`
|
|
- Run a script in a specific package: `pnpm --filter <package_name> run <script>`
|
|
- Run a script in all packages: `pnpm -r run <script>`
|
|
|
|
## Monorepo Tooling
|
|
|
|
We use **Turbo** for build system orchestration.
|
|
- Configuration: `turbo.json`
|
|
|
|
## Project Structure
|
|
|
|
- `apps/`: Contains application services (admin, api, live, proxy, space, web).
|
|
- `packages/`: Contains shared packages and libraries.
|
|
- `deployments/`: Deployment configurations.
|
|
|
|
## Running Tests
|
|
|
|
- To run tests in a specific package (e.g., codemods):
|
|
```bash
|
|
cd packages/codemods
|
|
pnpm run test
|
|
```
|
|
- Or from root:
|
|
```bash
|
|
pnpm --filter @plane/codemods run test
|
|
```
|
|
|
|
## Docker
|
|
|
|
- Local development uses `docker-compose-local.yml`.
|
|
- Production/Staging uses `docker-compose.yml`.
|