Skip to content

Commit e8486b0

Browse files
authored
Merge branch 'main' into update-supported-enterprise-server-versions
2 parents 739e14d + 0cbd4b5 commit e8486b0

File tree

111 files changed

+9299
-3597
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

111 files changed

+9299
-3597
lines changed

.github/workflows/script/check-node-modules.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ npm run removeNPMAbsolutePaths
1414
# Check that repo is still clean
1515
if [ ! -z "$(git status --porcelain)" ]; then
1616
# If we get a fail here then the PR needs attention
17-
>&2 echo "Failed: node_modules are not up to date. Run 'npm ci' and 'npm run removeNPMAbsolutePaths' to update"
17+
>&2 echo "Failed: node_modules are not up to date. Run 'npm ci && npm run removeNPMAbsolutePaths' on a macOS machine to update. Note it is important this command is run on macOS and not any other operating system as there is one dependency (fsevents) that is needed for macOS and may not be installed if the command is run on a Windows or Linux machine."
1818
git status
1919
exit 1
2020
fi

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Please note that this project is released with a [Contributor Code of Conduct][c
1212

1313
## Development and Testing
1414

15-
Before you start, ensure that you have a recent version of node installed. You can see which version of node is used by the action in `init/action.yml`.
15+
Before you start, ensure that you have a recent version of node (14 or higher) installed, along with a recent version of npm (7 or higher). You can see which version of node is used by the action in `init/action.yml`.
1616

1717
### Common tasks
1818

@@ -28,7 +28,7 @@ You may want to run `tsc --watch` from the command line or inside of vscode in o
2828

2929
Because CodeQL Action users consume the code directly from this repository, and there can be no build step during an GitHub Actions run, this repository contains all compiled artifacts and node modules. There is a PR check that will fail if any of the compiled artifacts are not up to date. Compiled artifacts are stored in the `lib/` directory. For all day-to-day development purposes, this folder can be ignored.
3030

31-
Only run `npm install` if you are explicitly changing the set of dependencies in `package.json`. The `node_modules` directory should be up to date when you check out, but if for some reason, there is an inconsistency use `npm ci && npm run removeNPMAbsolutePaths` to ensure the directory is in a state consistent with the `package-lock.json`. There is a PR check to ensure the consistency of the `node_modules` directory.
31+
Only run `npm install` if you are explicitly changing the set of dependencies in `package.json`. The `node_modules` directory should be up to date when you check out, but if for some reason, there is an inconsistency use `npm ci && npm run removeNPMAbsolutePaths` to ensure the directory is in a state consistent with the `package-lock.json`. Note that due to a macOS-specific dependency, this command should be run on a macOS machine. There is a PR check to ensure the consistency of the `node_modules` directory.
3232

3333
### Running the action
3434

0 commit comments

Comments
 (0)