Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/beta-releases' into ga-releases
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Sep 18, 2024
2 parents 13ff7e9 + 73ef900 commit 125f9a9
Show file tree
Hide file tree
Showing 449 changed files with 12,988 additions and 8,705 deletions.
14 changes: 4 additions & 10 deletions .depcheckrc
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
ignores:
- '@mongodb-js/bump-monorepo-packages'
- '@mongodb-js/sbom-tools'
# TODO: We keep webpack-cli/serve and testing-library/dom at the root to work
# around weird npm workspace hoising issues caused by outdated transient
# dependencies. This can go away when we update webpack and leafygreen to the
# same version everywhere.
# TODO: We keep testing-library/dom at the root to work around weird npm
# workspace hoising issues caused by outdated transient dependencies. This can
# go away when we update all our usage of @testing-library packages to the
# version matching what @leafygreen is using
- '@testing-library/dom'
# TODO: To work around https://github.com/depcheck/depcheck/issues/688 we keep
# some babel dependencies at the root to guarantee that their version is not
# bumped higher than the version that breaks depcheck package
- '@babel/core'
- '@babel/parser'
- 'babel-loader'
# npm picks up the node-gyp installation in this repository rather than the
# one it ships with, so we install one of our own to get the version right
# (because we need one with vscode 2022 support for github actions CI)
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Bug Reports
url: https://jira.mongodb.org/projects/COMPASS/issues/
about: Report a bug via Jira.
url: https://jira.mongodb.org/
about: Report a bug to the COMPASS project in Jira.
- name: Feature Request
url: https://feedback.mongodb.com/forums/924283-compass
about: Request a new feature or enhancement via the MongoDB Feedback Engine.
Expand Down
6 changes: 5 additions & 1 deletion .github/workflows/authors-and-third-party-notices.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ jobs:
run: |
npm run update-security-test-summary
- name: Update tracking-plan.md
run: npm run update-tracking-plan

- name: Create Pull Request
id: cpr
uses: peter-evans/create-pull-request@v6
Expand All @@ -60,8 +63,9 @@ jobs:
THIRD-PARTY-NOTICES.md
AUTHORS
docs/security-test-summary.md
docs/tracking-plan.md
body: |
- Update `AUTHORS`, `THIRD-PARTY-NOTICES` and `docs/security-test-summary.md`
- Update `AUTHORS`, `THIRD-PARTY-NOTICES`, docs/tracking-plan.md and `docs/security-test-summary.md`
- name: Merge PR
env:
Expand Down
11 changes: 10 additions & 1 deletion .snyk
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,18 @@ ignore:
created: 2023-10-30T10:18:43.435Z
SNYK-JS-ELECTRON-7443355:
- '*':
reason: Not applicable as we do not open / allow opening random webpages in our Electron app.
reason: >-
Not applicable as we do not open / allow opening random webpages in
our Electron app.
expires: 2024-07-25T12:41:36.996Z
created: 2024-07-19T12:41:36.999Z
SNYK-JS-AGGRIDCOMMUNITY-7414157:
- '*':
reason: >-
Not applicable as we don't use ag-grid utils and the library never
passes user input directly to the merge function
expires: 2025-09-17T13:05:57.065Z
created: 2024-09-17T13:05:57.071Z
# patches apply the minimum changes required to fix a vulnerability
patch:
'npm:ms:20170412':
Expand Down
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -89,3 +89,4 @@ Ben Radcliffe <928675+bsradcliffe@users.noreply.github.com>
Betsy Button <36177962+betsybutton@users.noreply.github.com>
Vivian Xiao <57568527+VivianTNT@users.noreply.github.com>
admin-token-bot <36773031+admin-token-bot@users.noreply.github.com>
Kræn Hansen <mail@kraenhansen.dk>
20 changes: 12 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,11 @@ This repository includes a few recommended plugins for your convenience:
- ESLint extension highlights possible issues in your code following our common eslint configuration.
- ANTLR4 grammar support extension helps to work with the `bson-transpilers` package that is implemented with the help of antlr (.g and .g4 files).

### Working on Plugins
## Enabling DevTools

To enable the Chrome DevTools for the Electron renderer processes, click "Settings" under "MongoDB Compass Dev Local" in the top menu (or press <kbd>⌘</kbd> + <kbd>,</kbd>) and click "Enable DevTools" followed by "Save", which will enable a "Toggle DevTools" item in the "View" top menu. Click this to toggle the DevTools panel (or press <kbd>⌥</kbd> + <kbd>⌘</kbd> + <kbd>I</kbd>).

## Working on Plugins

> [!NOTE]
> For documentation regarding how to write plugin packages, check out the
Expand All @@ -51,7 +55,7 @@ In addition to running lerna commands directly, there are a few convenient npm s
- `npm run test-changed` will run tests in all packages and their dependants changed since `origin/HEAD`.
- `npm run check-changed` will run `eslint` and `depcheck` validation in all packages (ignoring dependants) changed since `origin/HEAD`

### Building Compass Locally
## Building Compass Locally

To build compass you can run `package-compass` script:

Expand Down Expand Up @@ -83,7 +87,7 @@ To speed up the process you might want to disable creating installer for the app
HADRON_SKIP_INSTALLER=true npm run package-compass
```

### Publishing Packages
## Publishing Packages

Compass is built out of a number of different NPM packages. Since all the relevant code is bundled in the packaged version of Compass with webpack, it is not necessary to publish any package to build and run the Compass application.

Expand All @@ -95,13 +99,13 @@ Merging that PR will trigger another CI job that will publish to NPM any package

The version of packages is calculated following conventional bumps: See https://github.com/mongodb-js/devtools-shared/tree/main/packages/bump-monorepo-packages for details.

### Add / Update / Remove Dependencies in Packages
## 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`.

Additionally if you want to update a version of an existing dependency, but don't want to figure out the scope manually, you can use `npm run where` helper script. To update `webpack` in every package that has it as a dev dependency you can run `npm run where "devDependencies['webpack']" -- install --save-dev webpack@latest`

### Creating a New Workspace / Package
## Creating a New Workspace / Package

To create a new package please use the `create-workspace` npm script:

Expand All @@ -111,9 +115,9 @@ npm run create-workspace [workspace name]

This will do all the initial workspace bootstrapping for you, ensuring that your package has all the standard configs set up and ready, and all the npm scripts aligned with other packages in the monorepo, which is important to get the most out of all the provided helpers in this repository (like `npm run check-changed` commands or to make sure that your tests will not immediately fail in CI because of the test timeout being too small)

### Caveats
## Caveats

#### `hdiutil: couldn't unmount "diskn" - Resource busy` or Similar `hdiutil` Errors
### `hdiutil: couldn't unmount "diskn" - Resource busy` or Similar `hdiutil` Errors

<!-- TODO: might go away after https://jira.mongodb.org/browse/COMPASS-4947 -->

Expand All @@ -123,7 +127,7 @@ Sometimes when trying to package compass on macOS you can run into the said erro
HADRON_SKIP_INSTALLER=true npm run test-package-compass
```

#### `Module did not self-register` or `Module '<path>' was compiled against a different Node.js version` Errors
### `Module did not self-register` or `Module '<path>' was compiled against a different Node.js version` Errors

<!-- TODO: should go away after https://jira.mongodb.org/browse/COMPASS-4896 -->

Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Is there anything else you’d like to see in Compass? Let us know by submitting
- [**@mongodb-js/compass-logging**](packages/compass-logging): Shared helpers for logging in Compass packages
- [**@mongodb-js/compass-maybe-protect-connection-string**](packages/compass-maybe-protect-connection-string): Utility for protecting connection strings if requested
- [**@mongodb-js/compass-settings**](packages/compass-settings): Settings for compass
- [**@mongodb-js/compass-telemetry**](packages/compass-telemetry): Compass telemetry
- [**@mongodb-js/compass-test-server**](packages/compass-test-server): Wrapper around mongodb-runner to manage test servers for Compass
- [**@mongodb-js/compass-user-data**](packages/compass-user-data): undefined
- [**@mongodb-js/compass-utils**](packages/compass-utils): Utilities for MongoDB Compass Development
Expand All @@ -62,6 +63,7 @@ Is there anything else you’d like to see in Compass? Let us know by submitting
- [**@mongodb-js/databases-collections-list**](packages/databases-collections-list): List view for the databases and collections
- [**@mongodb-js/explain-plan-helper**](packages/explain-plan-helper): Explain plan utility methods for MongoDB Compass
- [**@mongodb-js/my-queries-storage**](packages/my-queries-storage): Saved aggregations and queries storage
- [**@mongodb-js/reflux-state-mixin**](packages/reflux-state-mixin): Reflux stores mixin adding 'state' syntax similar to React components
- [**bson-transpilers**](packages/bson-transpilers): Source to source compilers using ANTLR
- [**compass-e2e-tests**](packages/compass-e2e-tests): E2E test suite for Compass app that follows smoke tests / feature testing matrix
- [**compass-preferences-model**](packages/compass-preferences-model): Compass preferences model
Expand All @@ -83,6 +85,7 @@ Is there anything else you’d like to see in Compass? Let us know by submitting
- [**@mongodb-js/eslint-plugin-compass**](configs/eslint-plugin-compass): Custom eslint rules for Compass monorepo
- [**@mongodb-js/mocha-config-compass**](configs/mocha-config-compass): Shared mocha mocha configuration for Compass packages
- [**@mongodb-js/prettier-config-compass**](configs/prettier-config-compass): Shared Compass prettier configuration
- [**@mongodb-js/testing-library-compass**](configs/testing-library-compass): Compass unit testing utils
- [**@mongodb-js/tsconfig-compass**](configs/tsconfig-compass): Shared Compass Typescript configuration
- [**@mongodb-js/webpack-config-compass**](configs/webpack-config-compass): Shared webpack configuration for Compass application and plugins

Expand Down
Loading

0 comments on commit 125f9a9

Please sign in to comment.