1. circleci/node@7.0.0

circleci/node@7.0.0

Certified
Sections
Easily install Node.js and its package managers (npm, yarn). Best of all, install your packages with caching enabled by default. Supports Linux x86_64, MacOS, and Arm64 V8.
Created: November 7, 2018Version Published: December 5, 2024Releases: 59
Org Usage:
5261
Categories:

Orb Quick Start Guide

Use CircleCI version 2.1 at the top of your .circleci/config.yml file.

1 version: 2.1

Add the orbs stanza below your version, invoking the orb:

1 2 orbs: node: circleci/node@7.0.0

Use node elements in your existing workflows and jobs.

Usage Examples

install_nodejs

Download and install any version of Node.js. Optionally installs Yarn with a parameter. You may use the default executor of this orb for a Node execution environment as well. Recommendation: It is highly recommended to utilize an environment such as Docker with Node preinstalled.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 version: '2.1' orbs: node: circleci/node@x.y jobs: install-node-example: docker: - image: cimg/base:stable steps: - checkout - node/install: install-yarn: true node-version: '16.13' - run: node --version workflows: test_my_app: jobs: - install-node-example

jest_test_results

Run tests with jest and produce and upload test reports. This assumes that you have configured your project to invoke jest as your test script and that you have the jest-junit package in your dev dependencies.

1 2 3 4 5 6 7 8 version: '2.1' orbs: node: circleci/node@x.y workflows: test: jobs: - node/test: test-results-for: jest

mocha_test_results

Run tests with mocha and produce and upload test reports. This assumes that you have configured your project to invoke mocha as your test script and that you have the mocha-junit-reporter and mocha-multi packages in your dev dependencies.

1 2 3 4 5 6 7 8 9 10 version: '2.1' orbs: node: circleci/node@x.y workflows: test: jobs: - node/test: executor: name: node/default test-results-for: mocha

node_npm_run

Drop-in solution to automatically run custom npm commands for your Node.js applications. This job will automatically download your code into any version node environment, install your dependencies with caching enabled, and execute your custom npm script.

1 2 3 4 5 6 7 8 9 10 version: '2.1' orbs: node: circleci/node@x.y workflows: run-npm-command: jobs: - node/run: executor: name: node/default npm-run: build

node_pnpm_run

Drop-in solution to automatically run custom pnpm commands for your Node.js applications. This job will automatically download your code into any version node environment, install your dependencies with caching enabled, and execute your custom pnpm script.

1 2 3 4 5 6 7 8 9 10 version: '2.1' orbs: node: circleci/node@x.y workflows: run-npm-command: jobs: - node/run: executor: name: node/default pnpm-run: build

node_test_and_deploy

Drop-in solution to automatically test your Node.js applications. This job will automatically download your code into any version node environment, install your dependencies with caching enabled, and execute your testing script. This example shows how easily with two orbs you can test your Node application and automatically deploy to Heroku when successful, and on the master branch.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 version: '2.1' orbs: heroku: circleci/heroku@x.y node: circleci/node@x.y workflows: test-and-deploy: jobs: - node/test: executor: name: node/default - heroku/deploy-via-git: filters: branches: only: - master requires: - node/test

node_yarn_run

Drop-in solution to automatically run custom yarn commands for your Node.js applications. This job will automatically download your code into any version node environment, install your dependencies with caching enabled, and execute your custom yarn script.

1 2 3 4 5 6 7 8 9 10 version: '2.1' orbs: node: circleci/node@x.y workflows: run-npm-command: jobs: - node/run: executor: name: node/default yarn-run: build

npm_install

By default, the "install-packages" command will attempt to utilize "npm ci". The command can however be overwritten to support an alternative package install command such as "npm install".

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 version: '2.1' orbs: node: circleci/node@x.y jobs: test: executor: node/default steps: - checkout - run: sudo npm install -g npm@latest - node/install-packages: cache-path: ~/project/node_modules override-ci-command: npm install - run: npm run test workflows: test_my_app: jobs: - test

pnpm_install

By default, the "install-packages" command will attempt to utilize "pnpm i --frozen-lockfile". The command can however be overwritten to support an alternative package install command such as "pnpm install".

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 version: '2.1' orbs: node: circleci/node@x.y jobs: test: executor: node/default steps: - checkout - run: sudo npm install -g npm@latest - node/install-packages: override-ci-command: pnpm i pkg-manager: pnpm - run: pnpm run test workflows: test_my_app: jobs: - test

run_matrix_testing

Easily test your application against multiple versions of Node.js in just a few lines. This example uses "Matrix" jobs to call the same node/test job multiple times at once, each with the Node version we have specified. Read more here: https://circleci.com/blog/you-are-what-you-git-how-your-vcs-branching-model-affects-your-delivery-cadence/

1 2 3 4 5 6 7 8 9 10 11 12 13 version: '2.1' orbs: node: circleci/node@x.y workflows: matrix-tests: jobs: - node/test: matrix: parameters: executor: - node13 - node12 - node10

run_tests_with_npm

How to quickly and easily run your Node.js tests on CircleCI with caching automatically included. This example assumes you are using NPM as your package manager. The "npm ci" command will automatically be applied and the "~/.npm" directory cached.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 version: '2.1' orbs: node: circleci/node@x.y jobs: test: executor: name: node/default tag: '13.14' steps: - checkout - node/install-packages - run: command: npm run test workflows: test_my_app: jobs: - test

run_tests_with_pnpm

Utilize the pnpm package manager with the CircleCI Node orb. Caching of your Node packages is enabled by default.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 version: '2.1' orbs: node: circleci/node@x.y jobs: test: executor: name: node/default tag: '16' steps: - checkout - node/install-packages: pkg-manager: pnpm - run: command: pnpm run test name: Run pnpm tests workflows: test_my_app: jobs: - test

run_tests_with_yarn

Utilize the YARN package manager with the CircleCI Node orb. Caching of your Node packages is enabled by default.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 version: '2.1' orbs: node: circleci/node@x.y jobs: test: executor: name: node/default tag: '16' steps: - checkout - node/install-packages: pkg-manager: yarn - run: command: yarn run test name: Run YARN tests workflows: test_my_app: jobs: - test

test_results

Run tests with jest and produce and upload test reports. This assumes that you have configured your project so that your test script will produce the junit.xml file.

1 2 3 4 5 6 7 8 9 10 version: '2.1' orbs: node: circleci/node@x.y workflows: test: jobs: - node/test: executor: name: node/default test-results-path: junit.xml

yarn_berry_zero_install

Utilize the YARN v2 package manager + Zero installs with the CircleCI Node orb.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 version: '2.1' orbs: node: circleci/node@x.y jobs: test: executor: name: node/default tag: '16' steps: - checkout - node/install-packages: check-cache: always pkg-manager: yarn-berry with-cache: false - run: command: yarn run test name: Run YARN tests workflows: test_my_app: jobs: - test

Jobs

run

Simple drop-in job to run commands for your Node.js application automatically.

Show job Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
app-dir
Path to the directory containing your package.json file. Not needed if package.json lives in the root.
No
~/project
string
artifacts-path
Path to a file or directory to upload to artifacts after running the script.
No
''
string
cache-only-lockfile
If true, package.json will be ignored in the cache key. Useful for projects where package.json changes do not always invalidate dependencies. Note: package.json will still be the final fallback key incase a project is not configured with a lock file.
No
true
boolean
cache-path
By default, this orb will utilize 'npm ci' and cache the '~/.npm' directory. Override which path to cache with this parameter. The cache will be ignored when using npm ci, as the command doesn't benefit from cache.
No
''
string
cache-version
Change the default cache version if you need to clear the cache for any reason.
No
v1
string
check-cache
Yarn berry only for Zero install support - Use 'always' to always --check-cache argument to yarn install. Use 'detect' to enable caching of yarn.lock and to only add when required.
No
never
enum
executor
The name of executor to use.
No
default
executor
include-branch-in-cache-key
If true, this cache bucket will only apply to jobs within the same branch.
No
false
boolean
npm-run
The name of the script within your package.json which you would like to run.
No
''
string
override-ci-command
By default, packages will be installed with "npm ci" or "yarn install --frozen-lockfile". Optionally supply a custom package installation command, with any additional flags needed.
No
''
string
parallelism
The number of parallel jobs to run. See https://circleci.com/docs/parallelism-faster-jobs/
No
1
integer
pkg-manager
Select the default node package manager to use.
No
npm
enum
pnpm-run
The name of the script within your package.json which you would like to run.
No
''
string
post_install_steps
Provide any optional steps you would like to run after installing the node dependencies.
No
[]
steps
setup
Provide any optional steps you would like to run prior to installing the node dependencies. This is a good place to install global modules.
No
[]
steps
with-cache
Cache your node packages automatically for faster install times. Cache will be ignored when using npm ci.
No
true
boolean
yarn-run
The name of the script within your package.json which you would like to run.
No
''
string

test

Simple drop-in job to test your Node.js application automatically.

Show job Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
app-dir
Path to the directory containing your package.json file. Not needed if package.json lives in the root.
No
~/project
string
cache-only-lockfile
If true, package.json will be ignored in the cache key. Useful for projects where package.json changes do not always invalidate dependencies. Note: package.json will still be the final fallback key incase a project is not configured with a lock file.
No
true
boolean
cache-path
By default, this orb will utilize 'npm ci' and cache the '~/.npm' directory. Override which path to cache with this parameter. The cache will be ignored when using npm ci, as the command doesn't benefit from cache.
No
''
string
cache-version
Change the default cache version if you need to clear the cache for any reason.
No
v1
string
check-cache
Yarn berry only for Zero install support - Use 'always' to always --check-cache argument to yarn install. Use 'detect' to enable caching of yarn.lock and to only add when required.
No
never
enum
executor
The name of executor to use.
No
default
executor
include-branch-in-cache-key
If true, this cache bucket will only apply to jobs within the same branch.
No
false
boolean
override-ci-command
By default, packages will be installed with "npm ci" or "yarn install --frozen-lockfile". Optionally supply a custom package installation command, with any additional flags needed.
No
''
string
parallelism
The number of parallel jobs to run. See https://circleci.com/docs/parallelism-faster-jobs/
No
1
integer
pkg-manager
Select the default node package manager to use.
No
npm
enum
post_install_steps
Provide any optional steps you would like to run after installing the node dependencies.
No
[]
steps
run-command
The name of the script within your package.json which will run your tests.
No
test
string
setup
Provide any optional steps you would like to run prior to installing the node dependencies. This is a good place to install global modules.
No
[]
steps
test-coverage-path
Set this to the location where code coverage files will be placed after running tests. The code coverage files will be uploaded to artifacts for this workflow.
No
''
string
test-results-for
Testing framework your project uses. If this is set to jest or mocha, test results will be automatically produced. When using jest, the jest-junit package is required as a dev dependency. See https://github.com/jest-community/jest-junit for more information. When using mocha, the mocha-junit-reporter and mocha-multi packages are required as dev dependency. See https://github.com/michaelleeallen/mocha-junit-reporter and https://github.com/glenjamin/mocha-multi for more information.
No
other
enum
test-results-path
If you use test-results-for, this will be configured automatically. If you configure test results yourself (for example in your node config files) set this to the location that you write them to, and they will be uploaded.
No
''
string
with-cache
Cache your node packages automatically for faster install times. Cache will be ignored when using npm ci.
No
true
boolean

Commands

install

Install custom versions of Node.js, and optionally NPM/pnpm/Yarn, in any execution environment (Docker/Linux, macOS, machine) that does not have it preinstalled. Recommendation: It is highly recommended to utilize an environment such as Docker with Node preinstalled.

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
install-pnpm
Install pnpm?
No
false
boolean
install-yarn
Install Yarn?
No
false
boolean
node-version
Specify the full version tag to install. To install the latest version, set the version to `latest`. If unspecified, the version listed in .nvmrc or .node-version will be installed. If no .nvmrc file and .node-version file exists the active LTS version of Node.js will be installed by default. For a full list of releases, see the following: https://nodejs.org/en/download/releases
No
''
string
nvm-cache-key
Cache key to use when downloading nodejs. This is only used when use-nvm-cache is set to true. Defaults to nvm-v1-cache, update this value if you need to restart the cache. The node-version is added by default at the end of the cache key. If you are using multiple executors, add the executor as part of the key.
No
nvm-v1-cache
string
pnpm-version
Pick a version of pnpm to install (if no version is specified, the latest stable version will be installed): https://github.com/pnpm/pnpm/releases
No
''
string
use-nvm-cache
Indicates if cache would be used when installing nodejs, this would reduce the amount of errors when downloading the binaries. Defaults to true.
No
true
boolean
yarn-version
Pick a version of Yarn to install (if no version is specified, the latest stable version will be installed): https://github.com/yarnpkg/yarn/releases
No
''
string

install-packages

Install your Node packages with automated caching and best practices applied. Requires lock file.

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
app-dir
Path to the directory containing your package.json file. Not needed if package.json lives in the root.
No
.
string
cache-only-lockfile
If true, package.json will be ignored in the cache key. Useful for projects where package.json changes do not always invalidate dependencies. Note: package.json will still be the final fallback key incase a project is not configured with a lock file.
No
true
boolean
cache-path
By default, this orb will utilize 'npm ci' and cache the '~/.npm' directory. Override which path to cache with this parameter. The cache will be ignored when using npm ci, as the command doesn't benefit from cache.
No
''
string
cache-version
Change the default cache version if you need to clear the cache for any reason.
No
v1
string
check-cache
Yarn berry only for Zero install support - Use 'always' to always --check-cache argument to yarn install. Use 'detect' to enable caching of yarn.lock and to only add when required.
No
never
enum
include-branch-in-cache-key
If true, this cache bucket will only apply to jobs within the same branch.
No
false
boolean
override-ci-command
By default, packages will be installed with "npm ci", "yarn install --frozen-lockfile", "yarn install --immutable" or "pnpm install --frozen-lockfile". Optionally supply a custom package installation command, with any additional flags needed. When the command npm ci is used, no cache will be used, as the command doesn't benefit from it.
No
''
string
pkg-manager
Select the default node package manager to use. NPM v5+ Required. To use yarn-berry your package.json must have packageManager set to a yarn berry version, otherwise it will use old yarn.
No
npm
enum
with-cache
Cache your node packages automatically for faster install times. Cache will be ignored when using npm ci.
No
true
boolean

install-pnpm

Install a custom version of the pnpm package manager

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
version
Pick a version of pnpm to install (if no version is specified, the latest stable version will be installed): https://github.com/pnpm/pnpm/releases
No
''
string

install-yarn

Install a custom version of the Yarn package manager

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
version
Pick a version of Yarn to install (if no version is specified, the latest stable version will be installed): https://github.com/yarnpkg/yarn/releases
No
''
string

Executors

default

Select the version of Node.js to use. Uses CircleCI's highly cached convenience images built for CI. Any available tag from this list can be used: https://hub.docker.com/r/cimg/node/tags

Show executor Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
resource_class
Configure the executor resource class
No
large
enum
tag
Pick a specific cimg/node image version tag: https://hub.docker.com/r/cimg/node
No
lts
string

Orb Source

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 # This code is licensed from CircleCI to the user under the MIT license. # See here for details: https://circleci.com/developer/orbs/licensing version: 2.1 description: | Easily install Node.js and its package managers (npm, yarn). Best of all, install your packages with caching enabled by default. Supports Linux x86_64, MacOS, and Arm64 V8. display: home_url: https://nodejs.org/ source_url: https://github.com/circleci-public/node-orb commands: install: description: | Install custom versions of Node.js, and optionally NPM/pnpm/Yarn, in any execution environment (Docker/Linux, macOS, machine) that does not have it preinstalled. Recommendation: It is highly recommended to utilize an environment such as Docker with Node preinstalled. parameters: install-pnpm: default: false description: Install pnpm? type: boolean install-yarn: default: false description: Install Yarn? type: boolean node-version: default: "" description: | Specify the full version tag to install. To install the latest version, set the version to `latest`. If unspecified, the version listed in .nvmrc or .node-version will be installed. If no .nvmrc file and .node-version file exists the active LTS version of Node.js will be installed by default. For a full list of releases, see the following: https://nodejs.org/en/download/releases type: string nvm-cache-key: default: nvm-v1-cache description: | Cache key to use when downloading nodejs. This is only used when use-nvm-cache is set to true. Defaults to nvm-v1-cache, update this value if you need to restart the cache. The node-version is added by default at the end of the cache key. If you are using multiple executors, add the executor as part of the key. type: string pnpm-version: default: "" description: | Pick a version of pnpm to install (if no version is specified, the latest stable version will be installed): https://github.com/pnpm/pnpm/releases type: string use-nvm-cache: default: true description: | Indicates if cache would be used when installing nodejs, this would reduce the amount of errors when downloading the binaries. Defaults to true. type: boolean yarn-version: default: "" description: | Pick a version of Yarn to install (if no version is specified, the latest stable version will be installed): https://github.com/yarnpkg/yarn/releases type: string steps: - when: condition: <<parameters.use-nvm-cache>> steps: - restore_cache: keys: - <<parameters.nvm-cache-key>>-<<parameters.node-version>>-{{ arch }} name: Restore Nvm Cache - run: command: "#!/usr/bin/env bash\n# shellcheck disable=SC2016\n\n# Only install nvm if it's not already installed\nif command -v nvm &> /dev/null; then\n echo \"nvm is already installed. Skipping nvm install.\";\nelse\n curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash;\n \n echo 'export NVM_DIR=\"$HOME/.nvm\"' >> \"$BASH_ENV\";\n echo '[ -s \"$NVM_DIR/nvm.sh\" ] && \\. \"$NVM_DIR/nvm.sh\" --no-use' >> \"$BASH_ENV\";\n \n # shellcheck source=/dev/null\n source \"$BASH_ENV\";\nfi\n\n# See: https://github.com/nvm-sh/nvm#usage\nif [ \"$NODE_PARAM_VERSION\" = \"latest\" ]; then\n # When no version is specified we default to the latest version of Node\n NODE_ORB_INSTALL_VERSION=$(nvm ls-remote | tail -n1 | grep -Eo 'v[0-9]+\\.[0-9]+\\.[0-9]+')\n nvm install -b \"$NODE_ORB_INSTALL_VERSION\" # aka nvm install node. We're being explicit here.\n nvm alias default \"$NODE_ORB_INSTALL_VERSION\"\nelif [ -n \"$NODE_PARAM_VERSION\" ] && [ \"$NODE_PARAM_VERSION\" != \"lts\" ]; then\n nvm install -b \"$NODE_PARAM_VERSION\"\n nvm alias default \"$NODE_PARAM_VERSION\"\nelif [ -f \".nvmrc\" ]; then\n NVMRC_SPECIFIED_VERSION=$(<.nvmrc)\n nvm install -b \"$NVMRC_SPECIFIED_VERSION\"\n nvm alias default \"$NVMRC_SPECIFIED_VERSION\"\nelif [ -f \".node-version\" ]; then\n NVMRC_SPECIFIED_VERSION=$(<.node-version)\n nvm install \"$NVMRC_SPECIFIED_VERSION\"\n nvm alias default \"$NVMRC_SPECIFIED_VERSION\"\nelse\n nvm install -b --lts\n nvm alias default lts/*\nfi\n\necho 'nvm use default &>/dev/null' >> \"$BASH_ENV\"\n" environment: NODE_PARAM_VERSION: <<parameters.node-version>> name: Install Node.js <<parameters.node-version>> - when: condition: <<parameters.use-nvm-cache>> steps: - save_cache: key: <<parameters.nvm-cache-key>>-<<parameters.node-version>>-{{ arch }} name: Save Nvm Cache paths: - ~/.nvm/.cache - /opt/circleci/.nvm/.cache - when: condition: <<parameters.install-pnpm>> steps: - install-pnpm: version: <<parameters.pnpm-version>> - when: condition: <<parameters.install-yarn>> steps: - install-yarn: version: <<parameters.yarn-version>> install-packages: description: | Install your Node packages with automated caching and best practices applied. Requires lock file. parameters: app-dir: default: . description: Path to the directory containing your package.json file. Not needed if package.json lives in the root. type: string cache-only-lockfile: default: true description: | If true, package.json will be ignored in the cache key. Useful for projects where package.json changes do not always invalidate dependencies. Note: package.json will still be the final fallback key incase a project is not configured with a lock file. type: boolean cache-path: default: "" description: | By default, this orb will utilize 'npm ci' and cache the '~/.npm' directory. Override which path to cache with this parameter. The cache will be ignored when using npm ci, as the command doesn't benefit from cache. type: string cache-version: default: v1 description: Change the default cache version if you need to clear the cache for any reason. type: string check-cache: default: never description: | Yarn berry only for Zero install support - Use 'always' to always --check-cache argument to yarn install. Use 'detect' to enable caching of yarn.lock and to only add when required. enum: - never - always - detect type: enum include-branch-in-cache-key: default: false description: | If true, this cache bucket will only apply to jobs within the same branch. type: boolean override-ci-command: default: "" description: | By default, packages will be installed with "npm ci", "yarn install --frozen-lockfile", "yarn install --immutable" or "pnpm install --frozen-lockfile". Optionally supply a custom package installation command, with any additional flags needed. When the command npm ci is used, no cache will be used, as the command doesn't benefit from it. type: string pkg-manager: default: npm description: | Select the default node package manager to use. NPM v5+ Required. To use yarn-berry your package.json must have packageManager set to a yarn berry version, otherwise it will use old yarn. enum: - npm - yarn - yarn-berry - pnpm type: enum with-cache: default: true description: | Cache your node packages automatically for faster install times. Cache will be ignored when using npm ci. type: boolean steps: - run: command: |- #!/usr/bin/env bash # Fail if package.json does not exist in working directory if [ ! -f "package.json" ]; then echo echo "---" echo "Unable to find your package.json file. Did you forget to set the app-dir parameter?" echo "---" echo echo "Current directory: $(pwd)" echo echo echo "List directory: " echo ls exit 1 fi name: Checking for package.json working_directory: <<parameters.app-dir>> - when: condition: and: - << parameters.with-cache >> - or: - not: equal: - npm - << parameters.pkg-manager >> - and: - << parameters.override-ci-command >> - not: equal: - npm-ci - << parameters.override-ci-command >> steps: - run: command: | #!/usr/bin/env bash TARGET_DIR="/tmp" if [ -n "$HOMEDRIVE" ]; then TARGET_DIR="$HOMEDRIVE\\tmp" fi # Link corresponding lock file to a temporary file used by cache commands if [ -f "package-lock.json" ]; then echo "Found package-lock.json file, assuming lockfile" cp package-lock.json "$TARGET_DIR"/node-project-lockfile elif [ -f "npm-shrinkwrap.json" ]; then echo "Found npm-shrinkwrap.json file, assuming lockfile" cp npm-shrinkwrap.json "$TARGET_DIR"/node-project-lockfile elif [ -f "yarn.lock" ]; then echo "Found yarn.lock file, assuming lockfile" cp yarn.lock "$TARGET_DIR"/node-project-lockfile elif [ -f "pnpm-lock.yaml" ]; then echo "Found pnpm-lock.yaml file, assuming lockfile" cp pnpm-lock.yaml "$TARGET_DIR"/node-project-lockfile else echo "Found no lockfile, adding empty one" touch "$TARGET_DIR"/node-project-lockfile fi cp package.json "$TARGET_DIR"/node-project-package.json name: Determine lockfile working_directory: <<parameters.app-dir>> - restore_cache: keys: - node-deps-{{ arch }}-<<parameters.cache-version>>-<<#parameters.include-branch-in-cache-key>>{{ .Branch }}-<</parameters.include-branch-in-cache-key>><<^parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-package.json" }}-<</parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-lockfile" }} - node-deps-{{ arch }}-<<parameters.cache-version>>-<<#parameters.include-branch-in-cache-key>>{{ .Branch }}-<</parameters.include-branch-in-cache-key>>{{ checksum "/tmp/node-project-package.json" }} - node-deps-{{ arch }}-<<parameters.cache-version>>-<<#parameters.include-branch-in-cache-key>>{{ .Branch }}-<</parameters.include-branch-in-cache-key>> - when: condition: equal: - npm - << parameters.pkg-manager >> steps: - run: command: |- #!/usr/bin/env bash # Configure npm cache path if provided if [[ -n "$PARAM_CACHE_PATH" ]] && [[ "$PARAM_OVERRIDE_COMMAND" != "npm ci" ]] && [[ -n "$PARAM_OVERRIDE_COMMAND" ]]; then npm config set cache "$PARAM_CACHE_PATH" fi # Run override ci command if provided, otherwise run default npm install if [[ -n "$PARAM_OVERRIDE_COMMAND" ]]; then echo "Running override package installation command:" eval "$PARAM_OVERRIDE_COMMAND" else npm ci fi environment: PARAM_CACHE_PATH: << parameters.cache-path >> PARAM_OVERRIDE_COMMAND: << parameters.override-ci-command >> name: Installing NPM packages working_directory: <<parameters.app-dir>> - when: condition: and: - << parameters.with-cache >> - << parameters.override-ci-command >> - not: equal: - npm-ci - << parameters.override-ci-command >> steps: - when: condition: << parameters.cache-path >> steps: - save_cache: key: node-deps-{{ arch }}-<<parameters.cache-version>>-<<#parameters.include-branch-in-cache-key>>{{ .Branch }}-<</parameters.include-branch-in-cache-key>><<^parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-package.json" }}-<</parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-lockfile" }} paths: - << parameters.cache-path >> - unless: condition: << parameters.cache-path >> steps: - save_cache: key: node-deps-{{ arch }}-<<parameters.cache-version>>-<<#parameters.include-branch-in-cache-key>>{{ .Branch }}-<</parameters.include-branch-in-cache-key>><<^parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-package.json" }}-<</parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-lockfile" }} paths: - ~/.npm - when: condition: equal: - pnpm - << parameters.pkg-manager >> steps: - run: command: | #!/usr/bin/env bash # Run override ci command if provided, otherwise run default npm install if [[ -n "$PARAM_OVERRIDE_COMMAND" ]]; then echo "Running override package installation command:" eval "$PARAM_OVERRIDE_COMMAND" else pnpm install --frozen-lockfile fi environment: PARAM_CACHE_PATH: << parameters.cache-path >> PARAM_OVERRIDE_COMMAND: << parameters.override-ci-command >> name: Installing PNPM packages working_directory: <<parameters.app-dir>> - when: condition: << parameters.with-cache >> steps: - when: condition: << parameters.cache-path >> steps: - save_cache: key: node-deps-{{ arch }}-<<parameters.cache-version>>-<<#parameters.include-branch-in-cache-key>>{{ .Branch }}-<</parameters.include-branch-in-cache-key>><<^parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-package.json" }}-<</parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-lockfile" }} paths: - <<parameters.cache-path>> - unless: condition: << parameters.cache-path >> steps: - save_cache: key: node-deps-{{ arch }}-<<parameters.cache-version>>-<<#parameters.include-branch-in-cache-key>>{{ .Branch }}-<</parameters.include-branch-in-cache-key>><<^parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-package.json" }}-<</parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-lockfile" }} paths: - <<parameters.app-dir>>/node_modules - when: condition: equal: - yarn - << parameters.pkg-manager >> steps: - run: command: |- #!/usr/bin/env bash # Run override ci command if provided, otherwise run default yarn install if [[ -n "$PARAM_OVERRIDE_COMMAND" ]]; then echo "Running override package installation command:" eval "$PARAM_OVERRIDE_COMMAND" else yarn install --frozen-lockfile fi environment: PARAM_OVERRIDE_COMMAND: << parameters.override-ci-command >> YARN_CACHE_FOLDER: << parameters.cache-path >> name: Installing YARN packages working_directory: <<parameters.app-dir>> - when: condition: << parameters.with-cache >> steps: - when: condition: << parameters.cache-path >> steps: - save_cache: key: node-deps-{{ arch }}-<<parameters.cache-version>>-<<#parameters.include-branch-in-cache-key>>{{ .Branch }}-<</parameters.include-branch-in-cache-key>><<^parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-package.json" }}-<</parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-lockfile" }} paths: - <<parameters.cache-path>> - unless: condition: << parameters.cache-path >> steps: - save_cache: key: node-deps-{{ arch }}-<<parameters.cache-version>>-<<#parameters.include-branch-in-cache-key>>{{ .Branch }}-<</parameters.include-branch-in-cache-key>><<^parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-package.json" }}-<</parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-lockfile" }} paths: - <<parameters.app-dir>>/node_modules - when: condition: equal: - yarn-berry - << parameters.pkg-manager >> steps: - when: condition: equal: - detect - << parameters.check-cache >> steps: - restore_cache: keys: - yarn-berry-{{ arch }}-<<parameters.cache-version>>-<<#parameters.include-branch-in-cache-key>>{{ .Branch }}-<</parameters.include-branch-in-cache-key>>{{ checksum "/tmp/yarn-zero-lockfile" }} - yarn-berry-{{ arch }}-<<parameters.cache-version>>-<<#parameters.include-branch-in-cache-key>>{{ .Branch }}-<</parameters.include-branch-in-cache-key>> - run: command: |- #!/usr/bin/env bash if ! corepack enable; then echo "Using alternative corepack location" corepack enable --install-directory ~/bin fi # Run override ci command if provided, otherwise run default yarn install # See: https://yarnpkg.com/configuration/yarnrc/#cacheFolder if [[ -n "$PARAM_CACHE_PATH" ]]; then yarn config set cacheFolder "$PARAM_CACHE_PATH" fi if [[ -n "$PARAM_OVERRIDE_COMMAND" ]]; then echo "Running override package installation command:" eval "$PARAM_OVERRIDE_COMMAND" else # If a cache folder is already present, then we use Yarn Zero installs # See: https://yarnpkg.com/features/zero-installs if [[ -e "$PARAM_CACHE_PATH" ]]; then # See: https://yarnpkg.com/features/zero-installs#does-it-have-security-implications YARN_LOCKFILE_PATH="/tmp/yarn-zero-lockfile" if [[ "$PARAM_CHECK_CACHE" == "detect" ]]; then if [[ ! -f "$YARN_LOCKFILE_PATH" ]]; then echo "No yarn zero lockfile cached. Enabling check cache this run." ENABLE_CHECK_CACHE="true" elif [[ $(diff -q "$YARN_LOCKFILE_PATH" yarn.lock) ]]; then echo "Detected changes in lockfile. Enabling check cache this run." rm -f "$YARN_LOCKFILE_PATH" ENABLE_CHECK_CACHE="true" else echo "No changes detected in lockfile. Skipping check cache this run." fi fi if [[ "$PARAM_CHECK_CACHE" == "always" || -n "$ENABLE_CHECK_CACHE" ]]; then set -- "$@" --check-cache fi echo y | yarn install --immutable --immutable-cache "$@" if [[ "$PARAM_CHECK_CACHE" == "detect" && -n "$ENABLE_CHECK_CACHE" ]]; then cp yarn.lock "$YARN_LOCKFILE_PATH" fi else echo y | yarn install --immutable fi fi environment: PARAM_CACHE_PATH: << parameters.cache-path >> PARAM_CHECK_CACHE: << parameters.check-cache >> PARAM_OVERRIDE_COMMAND: << parameters.override-ci-command >> name: Installing YARN packages working_directory: <<parameters.app-dir>> - when: condition: equal: - detect - << parameters.check-cache >> steps: - save_cache: key: yarn-berry-{{ arch }}-<<parameters.cache-version>>-<<#parameters.include-branch-in-cache-key>>{{ .Branch }}-<</parameters.include-branch-in-cache-key>>{{ checksum "/tmp/yarn-zero-lockfile" }} paths: - <<parameters.cache-path>> - when: condition: << parameters.with-cache >> steps: - when: condition: << parameters.cache-path >> steps: - save_cache: key: node-deps-{{ arch }}-<<parameters.cache-version>>-<<#parameters.include-branch-in-cache-key>>{{ .Branch }}-<</parameters.include-branch-in-cache-key>><<^parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-package.json" }}-<</parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-lockfile" }} paths: - <<parameters.cache-path>> - unless: condition: << parameters.cache-path >> steps: - save_cache: key: node-deps-{{ arch }}-<<parameters.cache-version>>-<<#parameters.include-branch-in-cache-key>>{{ .Branch }}-<</parameters.include-branch-in-cache-key>><<^parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-package.json" }}-<</parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-lockfile" }} paths: - ~/.yarn/berry/cache - <<parameters.app-dir>>/.yarn/cache - when: condition: << parameters.with-cache >> steps: - run: command: rm -f /tmp/node-project-lockfile /tmp/node-project-package.json /tmp/yarn-zero-lockfile name: Remove temporary links install-pnpm: description: | Install a custom version of the pnpm package manager parameters: version: default: "" description: | Pick a version of pnpm to install (if no version is specified, the latest stable version will be installed): https://github.com/pnpm/pnpm/releases type: string steps: - run: command: | #!/usr/bin/env bash if [[ $EUID == 0 ]]; then export SUDO=""; else export SUDO="sudo"; fi # FUNCTIONS get_pnpm_version () { if [[ "$NODE_PARAM_PNPM_VERSION" == "" ]]; then PNPM_ORB_VERSION=$(curl -s https://cdn.jsdelivr.net/npm/pnpm/package.json | sed -n 's/.*version": "\(.*\)".*/\1/p') echo "Latest version of pnpm is $PNPM_ORB_VERSION" else PNPM_ORB_VERSION="$NODE_PARAM_PNPM_VERSION" echo "Selected version of pnpm is $PNPM_ORB_VERSION" fi } installation_check () { echo "Checking if pnpm is already installed..." if command -v pnpm > /dev/null 2>&1; then if pnpm --version | grep "$PNPM_ORB_VERSION" > /dev/null 2>&1; then echo "pnpm $PNPM_ORB_VERSION is already installed" exit 0 else echo "A different version of pnpm is installed ($(pnpm --version)); removing it" $SUDO rm -rf "$(pnpm store path)" > /dev/null 2>&1 $SUDO rm -rf "$PNPM_HOME" > /dev/null 2>&1 $SUDO npm rm -g pnpm > /dev/null 2>&1 fi fi } # cd to home so that pnpm --version will not use relative installed pnpm cd ~ || echo "Cannot change directory to home directory, pnpm version may be mismatched." get_pnpm_version installation_check # install pnpm echo "Installing pnpm v$PNPM_ORB_VERSION" npm install -g pnpm@"$PNPM_ORB_VERSION" # test/verify version echo "Verifying pnpm install" if pnpm --version | grep "$PNPM_ORB_VERSION" > /dev/null 2>&1; then echo "Success! pnpm $(pnpm --version) has been installed to $(command -v pnpm)" else echo "Something went wrong; the specified version of pnpm could not be installed" exit 1 fi environment: NODE_PARAM_PNPM_VERSION: <<parameters.version>> name: Install pnpm install-yarn: description: | Install a custom version of the Yarn package manager parameters: version: default: "" description: | Pick a version of Yarn to install (if no version is specified, the latest stable version will be installed): https://github.com/yarnpkg/yarn/releases type: string steps: - run: command: | #!/usr/bin/env bash if [[ $EUID == 0 ]]; then export SUDO=""; else export SUDO="sudo"; fi # FUNCTIONS get_yarn_version () { if [[ "$NODE_PARAM_YARN_VERSION" == "" ]]; then YARN_ORB_VERSION=$(curl -s https://cdn.jsdelivr.net/npm/yarn/package.json | sed -n 's/.*version": "\(.*\)".*/\1/p') echo "Latest version of Yarn is $YARN_ORB_VERSION" else YARN_ORB_VERSION="$NODE_PARAM_YARN_VERSION" echo "Selected version of Yarn is $YARN_ORB_VERSION" fi } installation_check () { echo "Checking if YARN is already installed..." if command -v yarn > /dev/null 2>&1; then if yarn --version | grep "$YARN_ORB_VERSION" > /dev/null 2>&1; then echo "Yarn $YARN_ORB_VERSION is already installed" exit 0 else echo "A different version of Yarn is installed ($(yarn --version)); removing it" if uname -a | grep Darwin > /dev/null 2>&1; then brew uninstall yarn > /dev/null 2>&1 elif grep Alpine /etc/issue > /dev/null 2>&1; then apk del yarn > /dev/null 2>&1 elif grep Debian /etc/issue > /dev/null 2>&1; then $SUDO apt-get remove yarn > /dev/null 2>&1 && \ $SUDO apt-get purge yarn > /dev/null 2>&1 OLD_YARN=$(which yarn) $SUDO rm "$OLD_YARN" elif grep Ubuntu /etc/issue > /dev/null 2>&1; then $SUDO apt-get remove yarn > /dev/null 2>&1 && \ $SUDO apt-get purge yarn > /dev/null 2>&1 OLD_YARN=$(which yarn) $SUDO rm "$OLD_YARN" elif command -v yum > /dev/null 2>&1; then yum remove yarn > /dev/null 2>&1 fi $SUDO rm -rf "$HOME/.yarn" > /dev/null 2>&1 $SUDO rm -f /usr/local/bin/yarn /usr/local/bin/yarnpkg > /dev/null 2>&1 fi fi } # cd to home so that yarn --version will not use relative installed yarn from .yarn/releases cd ~ || echo "Cannot change directory to home directory, yarn version may be mismatched." get_yarn_version installation_check # install yarn echo "Installing YARN v$YARN_ORB_VERSION" curl --retry 5 -L -o yarn.tar.gz --silent "https://yarnpkg.com/downloads/$YARN_ORB_VERSION/yarn-v$YARN_ORB_VERSION.tar.gz" $SUDO tar -xzf yarn.tar.gz && rm yarn.tar.gz $SUDO mkdir -p /opt/yarn $SUDO mv yarn-v"${YARN_ORB_VERSION}"/* /opt/yarn $SUDO rm -rf "yarn-v${YARN_ORB_VERSION}" $SUDO chmod 777 "/opt/yarn" $SUDO ln -s /opt/yarn/bin/yarn /usr/local/bin/yarn $SUDO ln -s /opt/yarn/bin/yarnpkg /usr/local/bin/yarnpkg $SUDO ln -s /opt/yarn/bin/yarn.js /usr/local/bin/yarn.js $SUDO mkdir -p ~/.config if uname -a | grep Darwin; then $SUDO chown -R "$USER:$GROUP" ~/.config $SUDO chown -R "$USER:$GROUP" /opt/yarn else $SUDO chown -R "$(whoami):$(whoami)" /opt/yarn $SUDO chown -R "$(whoami):$(whoami)" ~/.config fi # test/verify version echo "Verifying YARN install" if yarn --version | grep "$YARN_ORB_VERSION" > /dev/null 2>&1; then echo "Success! Yarn $(yarn --version) has been installed to $(command -v yarn)" else echo "Something went wrong; the specified version of Yarn could not be installed" exit 1 fi environment: NODE_PARAM_YARN_VERSION: <<parameters.version>> name: Install Yarn executors: default: description: | Select the version of Node.js to use. Uses CircleCI's highly cached convenience images built for CI. Any available tag from this list can be used: https://hub.docker.com/r/cimg/node/tags docker: - image: cimg/node:<<parameters.tag>> parameters: resource_class: default: large description: Configure the executor resource class enum: - small - medium - medium+ - large - xlarge - 2xlarge - 2xlarge+ type: enum tag: default: lts description: | Pick a specific cimg/node image version tag: https://hub.docker.com/r/cimg/node type: string resource_class: << parameters.resource_class >> jobs: run: description: | Simple drop-in job to run commands for your Node.js application automatically. executor: <<parameters.executor>> parallelism: <<parameters.parallelism>> parameters: app-dir: default: ~/project description: Path to the directory containing your package.json file. Not needed if package.json lives in the root. type: string artifacts-path: default: "" description: | Path to a file or directory to upload to artifacts after running the script. type: string cache-only-lockfile: default: true description: | If true, package.json will be ignored in the cache key. Useful for projects where package.json changes do not always invalidate dependencies. Note: package.json will still be the final fallback key incase a project is not configured with a lock file. type: boolean cache-path: default: "" description: | By default, this orb will utilize 'npm ci' and cache the '~/.npm' directory. Override which path to cache with this parameter. The cache will be ignored when using npm ci, as the command doesn't benefit from cache. type: string cache-version: default: v1 description: Change the default cache version if you need to clear the cache for any reason. type: string check-cache: default: never description: | Yarn berry only for Zero install support - Use 'always' to always --check-cache argument to yarn install. Use 'detect' to enable caching of yarn.lock and to only add when required. enum: - never - always - detect type: enum executor: default: default description: The name of executor to use. type: executor include-branch-in-cache-key: default: false description: | If true, this cache bucket will only apply to jobs within the same branch. type: boolean npm-run: default: "" description: The name of the script within your package.json which you would like to run. type: string override-ci-command: default: "" description: | By default, packages will be installed with "npm ci" or "yarn install --frozen-lockfile". Optionally supply a custom package installation command, with any additional flags needed. type: string parallelism: default: 1 description: The number of parallel jobs to run. See https://circleci.com/docs/parallelism-faster-jobs/ type: integer pkg-manager: default: npm description: Select the default node package manager to use. enum: - npm - yarn - yarn-berry - pnpm type: enum pnpm-run: default: "" description: The name of the script within your package.json which you would like to run. type: string post_install_steps: default: [] description: Provide any optional steps you would like to run after installing the node dependencies. type: steps setup: default: [] description: Provide any optional steps you would like to run prior to installing the node dependencies. This is a good place to install global modules. type: steps with-cache: default: true description: | Cache your node packages automatically for faster install times. Cache will be ignored when using npm ci. type: boolean yarn-run: default: "" description: The name of the script within your package.json which you would like to run. type: string steps: - checkout - steps: << parameters.setup >> - install-packages: app-dir: <<parameters.app-dir>> cache-only-lockfile: <<parameters.cache-only-lockfile>> cache-path: <<parameters.cache-path>> cache-version: <<parameters.cache-version>> check-cache: <<parameters.check-cache>> include-branch-in-cache-key: <<parameters.include-branch-in-cache-key>> override-ci-command: <<parameters.override-ci-command>> pkg-manager: <<parameters.pkg-manager>> with-cache: <<parameters.with-cache>> - steps: << parameters.post_install_steps >> - run: command: | #!/usr/bin/env bash if [[ "$ORB_PARAM_PKG_MANAGER" == "npm" ]]; then npm run "$ORB_PARAM_NPM_RUN" elif [[ "$ORB_PARAM_PKG_MANAGER" == "pnpm" ]]; then pnpm run "$ORB_PARAM_PNPM_RUN" else yarn run "$ORB_PARAM_YARN_RUN" fi environment: ORB_PARAM_NPM_RUN: <<parameters.npm-run>> ORB_PARAM_PKG_MANAGER: <<parameters.pkg-manager>> ORB_PARAM_PNPM_RUN: <<parameters.pnpm-run>> ORB_PARAM_YARN_RUN: <<parameters.yarn-run>> name: Run <<parameters.pkg-manager>> <<parameters.npm-run>> working_directory: <<parameters.app-dir>> - when: condition: <<parameters.artifacts-path>> steps: - store_artifacts: path: <<parameters.artifacts-path>> test: description: | Simple drop-in job to test your Node.js application automatically. executor: <<parameters.executor>> parallelism: <<parameters.parallelism>> parameters: app-dir: default: ~/project description: Path to the directory containing your package.json file. Not needed if package.json lives in the root. type: string cache-only-lockfile: default: true description: | If true, package.json will be ignored in the cache key. Useful for projects where package.json changes do not always invalidate dependencies. Note: package.json will still be the final fallback key incase a project is not configured with a lock file. type: boolean cache-path: default: "" description: | By default, this orb will utilize 'npm ci' and cache the '~/.npm' directory. Override which path to cache with this parameter. The cache will be ignored when using npm ci, as the command doesn't benefit from cache. type: string cache-version: default: v1 description: Change the default cache version if you need to clear the cache for any reason. type: string check-cache: default: never description: | Yarn berry only for Zero install support - Use 'always' to always --check-cache argument to yarn install. Use 'detect' to enable caching of yarn.lock and to only add when required. enum: - never - always - detect type: enum executor: default: default description: The name of executor to use. type: executor include-branch-in-cache-key: default: false description: | If true, this cache bucket will only apply to jobs within the same branch. type: boolean override-ci-command: default: "" description: | By default, packages will be installed with "npm ci" or "yarn install --frozen-lockfile". Optionally supply a custom package installation command, with any additional flags needed. type: string parallelism: default: 1 description: The number of parallel jobs to run. See https://circleci.com/docs/parallelism-faster-jobs/ type: integer pkg-manager: default: npm description: Select the default node package manager to use. enum: - npm - yarn - yarn-berry - pnpm type: enum post_install_steps: default: [] description: Provide any optional steps you would like to run after installing the node dependencies. type: steps run-command: default: test description: The name of the script within your package.json which will run your tests. type: string setup: default: [] description: Provide any optional steps you would like to run prior to installing the node dependencies. This is a good place to install global modules. type: steps test-coverage-path: default: "" description: | Set this to the location where code coverage files will be placed after running tests. The code coverage files will be uploaded to artifacts for this workflow. type: string test-results-for: default: other description: | Testing framework your project uses. If this is set to jest or mocha, test results will be automatically produced. When using jest, the jest-junit package is required as a dev dependency. See https://github.com/jest-community/jest-junit for more information. When using mocha, the mocha-junit-reporter and mocha-multi packages are required as dev dependency. See https://github.com/michaelleeallen/mocha-junit-reporter and https://github.com/glenjamin/mocha-multi for more information. enum: - jest - mocha - other type: enum test-results-path: default: "" description: | If you use test-results-for, this will be configured automatically. If you configure test results yourself (for example in your node config files) set this to the location that you write them to, and they will be uploaded. type: string with-cache: default: true description: | Cache your node packages automatically for faster install times. Cache will be ignored when using npm ci. type: boolean steps: - checkout - steps: << parameters.setup >> - install-packages: app-dir: <<parameters.app-dir>> cache-only-lockfile: <<parameters.cache-only-lockfile>> cache-path: <<parameters.cache-path>> cache-version: <<parameters.cache-version>> check-cache: <<parameters.check-cache>> include-branch-in-cache-key: <<parameters.include-branch-in-cache-key>> override-ci-command: <<parameters.override-ci-command>> pkg-manager: <<parameters.pkg-manager>> with-cache: <<parameters.with-cache>> - steps: << parameters.post_install_steps >> - when: condition: and: - equal: - npm - << parameters.pkg-manager >> - equal: - other - << parameters.test-results-for >> steps: - run: command: npm run <<parameters.run-command>> name: Run NPM Tests working_directory: <<parameters.app-dir>> - when: condition: and: - equal: - npm - << parameters.pkg-manager >> - equal: - jest - << parameters.test-results-for >> steps: - run: command: npm list jest-junit || (echo "Add the package jest-junit to the dev dependencies of your project with `npm install --save-dev jest-junit`" && exit 1) name: Check for test reporter working_directory: <<parameters.app-dir>> - run: command: npm run <<parameters.run-command>> -- --reporters=default --reporters=jest-junit name: Run NPM Tests working_directory: <<parameters.app-dir>> - when: condition: and: - equal: - npm - << parameters.pkg-manager >> - equal: - mocha - << parameters.test-results-for >> steps: - run: command: npm list mocha-junit-reporter mocha-multi || (echo "Add the packages mocha-junit-reporter & mocha-multi to the dev dependencies of your project with `npm install --save-dev mocha-junit-reporter mocha-multi`" && exit 1) name: Check for test reporter working_directory: <<parameters.app-dir>> - run: command: npm run <<parameters.run-command>> -- --reporter mocha-multi --reporter-options spec=-,mocha-junit-reporter=- name: Run NPM Tests working_directory: <<parameters.app-dir>> - when: condition: and: - equal: - yarn - << parameters.pkg-manager >> - equal: - other - << parameters.test-results-for >> steps: - run: command: yarn run <<parameters.run-command>> name: Run YARN Tests working_directory: <<parameters.app-dir>> - when: condition: and: - equal: - yarn - << parameters.pkg-manager >> - equal: - jest - << parameters.test-results-for >> steps: - run: command: yarn list --pattern jest-junit | grep " jest-junit@" || (echo "Add the package jest-junit to your projects dev dependencies with `yarn add --dev jest-junit`" && exit 1) name: Check for test reporter working_directory: <<parameters.app-dir>> - run: command: yarn run <<parameters.run-command>> --reporters=default --reporters=jest-junit name: Run YARN Tests working_directory: <<parameters.app-dir>> - when: condition: and: - equal: - yarn - << parameters.pkg-manager >> - equal: - mocha - << parameters.test-results-for >> steps: - run: command: yarn list --pattern "mocha-junit-reporter|mocha-multi" | grep "mocha-junit-reporter@\|mocha-multi@" || (echo "Add the packages mocha-junit-reporter & mocha-multi to the dev dependencies of your project with `yarn add --dev mocha-junit-reporter mocha-multi`" && exit 1) name: Check for test reporter working_directory: <<parameters.app-dir>> - run: command: yarn run <<parameters.run-command>> --reporter mocha-multi --reporter-options spec=-,mocha-junit-reporter=- name: Run YARN Tests working_directory: <<parameters.app-dir>> - when: condition: and: - equal: - yarn-berry - << parameters.pkg-manager >> - equal: - other - << parameters.test-results-for >> steps: - run: command: yarn run <<parameters.run-command>> name: Run YARN 2.x Tests working_directory: <<parameters.app-dir>> - when: condition: and: - equal: - yarn-berry - << parameters.pkg-manager >> - equal: - jest - << parameters.test-results-for >> steps: - run: command: yarn run <<parameters.run-command>> --reporters=default --reporters=jest-junit name: Run YARN 2.x Tests working_directory: <<parameters.app-dir>> - when: condition: and: - equal: - yarn-berry - << parameters.pkg-manager >> - equal: - mocha - << parameters.test-results-for >> steps: - run: command: yarn list --pattern "mocha-junit-reporter|mocha-multi" | grep "mocha-junit-reporter@\|mocha-multi@" || (echo "Add the packages mocha-junit-reporter & mocha-multi to the dev dependencies of your project with `yarn add --dev mocha-junit-reporter mocha-multi`" && exit 1) name: Check for test reporter working_directory: <<parameters.app-dir>> - run: command: yarn run <<parameters.run-command>> --reporter mocha-multi --reporter-options spec=-,mocha-junit-reporter=- name: Run YARN 2.x Tests working_directory: <<parameters.app-dir>> - when: condition: and: - equal: - pnpm - << parameters.pkg-manager >> - equal: - other - << parameters.test-results-for >> steps: - run: command: pnpm run <<parameters.run-command>> name: Run pnpm Tests working_directory: <<parameters.app-dir>> - when: condition: and: - equal: - pnpm - << parameters.pkg-manager >> - equal: - jest - << parameters.test-results-for >> steps: - run: command: pnpm list "jest-junit@*" | grep "jest-junit" || (echo "Add the package jest-junit to your projects dev dependencies with `pnpm add -D jest-junit`" && exit 1) name: Check for test reporter working_directory: <<parameters.app-dir>> - run: command: pnpm run <<parameters.run-command>> --reporters=default --reporters=jest-junit name: Run pnpm Tests working_directory: <<parameters.app-dir>> - when: condition: and: - equal: - pnpm - << parameters.pkg-manager >> - equal: - mocha - << parameters.test-results-for >> steps: - run: command: pnpm list "mocha-junit-reporter@*" "mocha-multi@*" | grep "mocha-junit-reporter\|mocha-multi" || (echo "Add the packages mocha-junit-reporter & mocha-multi to the dev dependencies of your project with `pnpm add -D mocha-junit-reporter mocha-multi`" && exit 1) name: Check for test reporter working_directory: <<parameters.app-dir>> - run: command: pnpm run <<parameters.run-command>> --reporter mocha-multi --reporter-options spec=-,mocha-junit-reporter=- name: Run pnpm Tests working_directory: <<parameters.app-dir>> - when: condition: << parameters.test-results-path >> steps: - store_test_results: path: << parameters.test-results-path >> - when: condition: and: - equal: - jest - << parameters.test-results-for >> - equal: - "" - << parameters.test-results-path >> steps: - store_test_results: path: <<parameters.app-dir>>/junit.xml - when: condition: and: - equal: - mocha - << parameters.test-results-for >> - equal: - "" - << parameters.test-results-path >> steps: - store_test_results: path: <<parameters.app-dir>>/test-results.xml - when: condition: <<parameters.test-coverage-path>> steps: - store_artifacts: path: <<parameters.test-coverage-path>> examples: install_nodejs: description: | Download and install any version of Node.js. Optionally installs Yarn with a parameter. You may use the default executor of this orb for a Node execution environment as well. Recommendation: It is highly recommended to utilize an environment such as Docker with Node preinstalled. usage: version: "2.1" orbs: node: circleci/node@x.y jobs: install-node-example: docker: - image: cimg/base:stable steps: - checkout - node/install: install-yarn: true node-version: "16.13" - run: node --version workflows: test_my_app: jobs: - install-node-example jest_test_results: description: | Run tests with jest and produce and upload test reports. This assumes that you have configured your project to invoke jest as your test script and that you have the jest-junit package in your dev dependencies. usage: version: "2.1" orbs: node: circleci/node@x.y workflows: test: jobs: - node/test: test-results-for: jest mocha_test_results: description: | Run tests with mocha and produce and upload test reports. This assumes that you have configured your project to invoke mocha as your test script and that you have the mocha-junit-reporter and mocha-multi packages in your dev dependencies. usage: version: "2.1" orbs: node: circleci/node@x.y workflows: test: jobs: - node/test: executor: name: node/default test-results-for: mocha node_npm_run: description: | Drop-in solution to automatically run custom npm commands for your Node.js applications. This job will automatically download your code into any version node environment, install your dependencies with caching enabled, and execute your custom npm script. usage: version: "2.1" orbs: node: circleci/node@x.y workflows: run-npm-command: jobs: - node/run: executor: name: node/default npm-run: build node_pnpm_run: description: | Drop-in solution to automatically run custom pnpm commands for your Node.js applications. This job will automatically download your code into any version node environment, install your dependencies with caching enabled, and execute your custom pnpm script. usage: version: "2.1" orbs: node: circleci/node@x.y workflows: run-npm-command: jobs: - node/run: executor: name: node/default pnpm-run: build node_test_and_deploy: description: | Drop-in solution to automatically test your Node.js applications. This job will automatically download your code into any version node environment, install your dependencies with caching enabled, and execute your testing script. This example shows how easily with two orbs you can test your Node application and automatically deploy to Heroku when successful, and on the master branch. usage: version: "2.1" orbs: heroku: circleci/heroku@x.y node: circleci/node@x.y workflows: test-and-deploy: jobs: - node/test: executor: name: node/default - heroku/deploy-via-git: filters: branches: only: - master requires: - node/test node_yarn_run: description: | Drop-in solution to automatically run custom yarn commands for your Node.js applications. This job will automatically download your code into any version node environment, install your dependencies with caching enabled, and execute your custom yarn script. usage: version: "2.1" orbs: node: circleci/node@x.y workflows: run-npm-command: jobs: - node/run: executor: name: node/default yarn-run: build npm_install: description: | By default, the "install-packages" command will attempt to utilize "npm ci". The command can however be overwritten to support an alternative package install command such as "npm install". usage: version: "2.1" orbs: node: circleci/node@x.y jobs: test: executor: node/default steps: - checkout - run: sudo npm install -g npm@latest - node/install-packages: cache-path: ~/project/node_modules override-ci-command: npm install - run: npm run test workflows: test_my_app: jobs: - test pnpm_install: description: | By default, the "install-packages" command will attempt to utilize "pnpm i --frozen-lockfile". The command can however be overwritten to support an alternative package install command such as "pnpm install". usage: version: "2.1" orbs: node: circleci/node@x.y jobs: test: executor: node/default steps: - checkout - run: sudo npm install -g npm@latest - node/install-packages: override-ci-command: pnpm i pkg-manager: pnpm - run: pnpm run test workflows: test_my_app: jobs: - test run_matrix_testing: description: | Easily test your application against multiple versions of Node.js in just a few lines. This example uses "Matrix" jobs to call the same node/test job multiple times at once, each with the Node version we have specified. Read more here: https://circleci.com/blog/you-are-what-you-git-how-your-vcs-branching-model-affects-your-delivery-cadence/ usage: version: "2.1" orbs: node: circleci/node@x.y workflows: matrix-tests: jobs: - node/test: matrix: parameters: executor: - node13 - node12 - node10 run_tests_with_npm: description: | How to quickly and easily run your Node.js tests on CircleCI with caching automatically included. This example assumes you are using NPM as your package manager. The "npm ci" command will automatically be applied and the "~/.npm" directory cached. usage: version: "2.1" orbs: node: circleci/node@x.y jobs: test: executor: name: node/default tag: "13.14" steps: - checkout - node/install-packages - run: command: npm run test workflows: test_my_app: jobs: - test run_tests_with_pnpm: description: | Utilize the pnpm package manager with the CircleCI Node orb. Caching of your Node packages is enabled by default. usage: version: "2.1" orbs: node: circleci/node@x.y jobs: test: executor: name: node/default tag: "16" steps: - checkout - node/install-packages: pkg-manager: pnpm - run: command: pnpm run test name: Run pnpm tests workflows: test_my_app: jobs: - test run_tests_with_yarn: description: | Utilize the YARN package manager with the CircleCI Node orb. Caching of your Node packages is enabled by default. usage: version: "2.1" orbs: node: circleci/node@x.y jobs: test: executor: name: node/default tag: "16" steps: - checkout - node/install-packages: pkg-manager: yarn - run: command: yarn run test name: Run YARN tests workflows: test_my_app: jobs: - test test_results: description: | Run tests with jest and produce and upload test reports. This assumes that you have configured your project so that your test script will produce the junit.xml file. usage: version: "2.1" orbs: node: circleci/node@x.y workflows: test: jobs: - node/test: executor: name: node/default test-results-path: junit.xml yarn_berry_zero_install: description: | Utilize the YARN v2 package manager + Zero installs with the CircleCI Node orb. usage: version: "2.1" orbs: node: circleci/node@x.y jobs: test: executor: name: node/default tag: "16" steps: - checkout - node/install-packages: check-cache: always pkg-manager: yarn-berry with-cache: false - run: command: yarn run test name: Run YARN tests workflows: test_my_app: jobs: - test
Developer Updates
Get tips to optimize your builds
Or join our research panel and give feedback
By submitting this form, you are agreeing to ourTerms of UseandPrivacy Policy.