Skip to content

Commit

Permalink
chore: add publishing documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Anemy committed Oct 7, 2024
1 parent fba89a7 commit 75fcb1b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,13 @@ After bootstrap is finished, you should be able to run `npm run start` and see C

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.

### Publishing Packages

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.

The version of packages is calculated following conventional bumps: https://www.conventionalcommits.org/en/v1.0.0/
See https://github.com/mongodb-js/devtools-shared/blob/main/packages/monorepo-tools/src/bump-packages.ts for details.

### Add / Update / Remove Dependencies in Packages

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`.
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,6 @@ To create a new workspace:
npm run create-workspace
```

## Contributing

For contributing, please refer to [CONTRIBUTING.md](CONTRIBUTING.md)

0 comments on commit 75fcb1b

Please sign in to comment.