Skip to content

Commit 7785fa3

Browse files
authored
chore: update build documentation in README MONGOSH-1225 (#1314)
Also bump boxednode, deduplicate the `NODE_JS_CONFIGURE_ARGS` env var that we introduced that is already supported by boxednode, and perform various minor updates to the rest of our docs.
1 parent 724684f commit 7785fa3

File tree

7 files changed

+25
-23
lines changed

7 files changed

+25
-23
lines changed

Diff for: .evergreen/compile-artifact.sh

+3-3
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ export TMPDIR=/tmp/m
2323
# able to compile OpenSSL with assembly support,
2424
# so we revert back to the slower version.
2525
if [ "$OS" == "Windows_NT" ]; then
26-
export NODE_JS_CONFIGURE_ARGS='["openssl-no-asm"]'
26+
export BOXEDNODE_CONFIGURE_ARGS='openssl-no-asm'
2727
elif uname -a | grep -q 'Darwin.*x86_64'; then
28-
export NODE_JS_CONFIGURE_ARGS='["--openssl-no-asm"]'
28+
export BOXEDNODE_CONFIGURE_ARGS='--openssl-no-asm'
2929
elif [ -n "$MONGOSH_SHARED_OPENSSL" ]; then
3030
pushd /tmp/m
3131
if [ "$MONGOSH_SHARED_OPENSSL" == "openssl11" ]; then
@@ -48,7 +48,7 @@ elif [ -n "$MONGOSH_SHARED_OPENSSL" ]; then
4848
popd # openssl-*
4949
popd # /tmp/m
5050

51-
export NODE_JS_CONFIGURE_ARGS='[
51+
export BOXEDNODE_CONFIGURE_ARGS='[
5252
"--shared-openssl",
5353
"--shared-openssl-includes=/tmp/m/opt/include",
5454
"--shared-openssl-libpath=/tmp/m/opt/lib",

Diff for: CODE_OF_CONDUCT.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
5555
## Enforcement
5656

5757
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58-
reported by contacting the project team at . All
58+
reported by contacting the project team at [email protected]. All
5959
complaints will be reviewed and investigated and will result in a response that
6060
is deemed necessary and appropriate to the circumstances. The project team is
6161
obligated to maintain confidentiality with regard to the reporter of an incident.

Diff for: README.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ variable. For detailed instructions for each of our supported platforms, please
9999
100100
### Requirements
101101
102-
- Node.js v14.x
102+
- Node.js v16.x
103103
- Python 3.x
104104
- The test suite uses [mlaunch](http://blog.rueckstiess.com/mtools/mlaunch.html)
105105
for managing running mongod, you can install that manually as well via
@@ -171,13 +171,22 @@ Compile the standalone executable (this may take some time):
171171
npm run compile-exec
172172
```
173173

174+
Relevant environment variables for compiling are:
175+
- `NODE_JS_VERSION`: Specify a Node.js version to use for compilation, e.g. `16.15.0` or `16.x`
176+
- `BOXEDNODE_CONFIGURE_ARGS`: Node.js configure flags as a comma-separated list
177+
or JSON array, e.g. `--shared-openssl,--shared-zlib`
178+
- `BOXEDNODE_MAKE_ARGS`: Node.js make args (no distinction from `BOXEDNODE_CONFIGURE_ARGS` on Windows)
179+
as a comma-separated list or JSON array, e.g. `-j12`
180+
174181
Compile a specific package, e.g. the `.deb` for Debian:
175182

176183
```shell
177184
npm run compile-exec
178-
npm run evergreen-release package -- --build-variant=debian-x64
185+
npm run evergreen-release package -- --build-variant=deb-x64
179186
```
180187

188+
Compilation and packaging output is written to `dist/`.
189+
181190
### Releasing
182191

183192
Refer to the [`build` package](./packages/build/README.md) documentation.

Diff for: package-lock.json

+7-7
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"mongosh": "packages/cli-repl/bin/mongosh.js"
77
},
88
"homepage": "https://github.com/mongodb-js/mongosh",
9-
"author": "Compass Team <team-compass@10gen.com>",
9+
"author": "Compass Team <compass@mongodb.com>",
1010
"scripts": {
1111
"prebootstrap-with-chromium": "npm install",
1212
"bootstrap-with-chromium": "lerna bootstrap --concurrency=1",
@@ -100,7 +100,7 @@
100100
"@typescript-eslint/parser": "^4.28.4",
101101
"aws-sdk": "^2.674.0",
102102
"axios": "^0.21.1",
103-
"boxednode": "^1.10.6",
103+
"boxednode": "^1.10.8",
104104
"browserify": "^16.5.0",
105105
"chai": "^4.2.0",
106106
"command-exists": "^1.2.9",

Diff for: packages/build/src/compile/signable-compiler.ts

-7
Original file line numberDiff line numberDiff line change
@@ -114,15 +114,8 @@ export class SignableCompiler {
114114
requireRegexp: /\bget_console_process_list\.node$/
115115
} : null;
116116

117-
let configureArgs: string[] = [];
118-
119-
if (process.env.NODE_JS_CONFIGURE_ARGS) {
120-
configureArgs = JSON.parse(process.env.NODE_JS_CONFIGURE_ARGS);
121-
}
122-
123117
// This compiles the executable along with Node from source.
124118
await compileJSFileAsBinary({
125-
configureArgs,
126119
sourceFile: this.sourceFile,
127120
targetFile: this.targetFile,
128121
nodeVersionRange: this.nodeVersionRange,

Diff for: packages/cli-repl/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"version": "0.0.0-dev.0",
44
"description": "MongoDB Shell CLI REPL Package",
55
"homepage": "https://github.com/mongodb-js/mongosh",
6-
"author": "Compass Team <team-compass@10gen.com>",
6+
"author": "Compass Team <compass@mongodb.com>",
77
"manufacturer": "MongoDB Inc.",
88
"main": "lib/index.js",
99
"types": "lib/index.d.ts",

0 commit comments

Comments
 (0)