Skip to content

Commit 1fd9027

Browse files
authored
chore: add publishing documentation (#482)
1 parent fba89a7 commit 1fd9027

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,13 @@ After bootstrap is finished, you should be able to run `npm run start` and see C
3333

3434
This monorepo is powered by [`npm workspaces`](https://docs.npmjs.com/cli/v7/using-npm/workspaces) and [`lerna`](https://github.com/lerna/lerna#readme), although not necessary, it might be helpful to have a high level understanding of those tools.
3535

36+
### Publishing Packages
37+
38+
Packages in the monorepo are automatically published when a change is merged into the `main` branch. This is done with a CI workflow. Each change to the `main` branch is analyzed to calculate new versions for impacted packages. A pr with the new versions of each changed package is created by a bot and merged on each new change.
39+
40+
The version of packages is calculated following conventional bumps: https://www.conventionalcommits.org/en/v1.0.0/
41+
See https://github.com/mongodb-js/devtools-shared/blob/main/packages/monorepo-tools/src/bump-packages.ts for details.
42+
3643
### Add / Update / Remove Dependencies in Packages
3744

3845
To add, remove, or update a dependency in any workspace you can use the usual `npm install` with a `--workspace` argument added, e.g. to add `react-aria` dependency to compass-aggregations and compass-query-bar plugins you can run `npm install --save react-aria --workspace @mongodb-js/compass-aggregations --workspace @mongodb-js/compass-query-bar`.

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,6 @@ To create a new workspace:
2626
npm run create-workspace
2727
```
2828

29+
## Contributing
30+
31+
For contributing, please refer to [CONTRIBUTING.md](CONTRIBUTING.md)

0 commit comments

Comments
 (0)