search

CircleCI-Public / node-orb

An orb for working with Node.js on CircleCI
https://circleci.com/orbs/registry/orb/circleci/node
MIT License
52 stars 80 forks source link

https://hub.docker.com/r/cimg/node #219

Closed Robbbo-T closed 3 months ago

Robbbo-T commented 3 months ago

Aquí tienes un texto que puedes copiar y pegar en tu comentario en el issue de GitHub:

Parece que hubo un malentendido respecto a la URL proporcionada. La URL que has dado es de un issue en el repositorio público de CircleCI para el orb de Node.js. Este issue específico trata sobre problemas y soluciones relacionadas con la ejecución de comandos npm ci y la gestión de caché en los orbs de CircleCI para Node.js.

Resumen del Issue y Soluciones Propuestas

Problema Original: El comando node/install-packages no ejecutaba npm ci por defecto, sino que utilizaba npm install, lo cual causaba problemas con la gestión de caché ya que npm ci elimina node_modules antes de reinstalarlas, invalidando la caché existente.

Solución Propuesta: Se modificó la lógica del orb para asegurar que npm ci sea el comando predeterminado cuando se utiliza override-ci: false. Además, se ajustaron las configuraciones de caché para que funcionen correctamente con npm ci, almacenando el caché en ~/.npm en lugar de node_modules.

Actualizaciones y Mejoras:

Cómo Proceder

Para aplicar estas soluciones en tu proyecto utilizando CircleCI y Node.js:

  1. Actualiza el Orb: Asegúrate de estar utilizando la versión más reciente del orb de Node.js en tu configuración de CircleCI.

    orbs:
 node: circleci/node@x.y.z

  2. Configura el Cache: Asegúrate de que tu configuración de caché en CircleCI esté alineada con las recomendaciones, almacenando el caché en ~/.npm para npm ci.

    jobs:
 test:
   docker:
     - image: circleci/node:lts
   steps:
     - checkout
     - node/install-packages:
         pkg-manager: npm
         cache-path: ~/.npm
     - run:
         command: npm run test

Recursos Adicionales

Esto debería ayudarte a configurar correctamente tu entorno de CI/CD en CircleCI para manejar mejor las instalaciones y cachés de paquetes Node.js. Si necesitas más ayuda, revisa los issues abiertos en el repositorio de GitHub para encontrar más detalles y soluciones similares.

--- cleci/node@x.y workflows: test-and-deploy: jobs:

Examples:

2 orbs: node: circleci/node@x.y workflows: run-npm-command: jobs:

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 version: '2.1' orbs: heroku: circleci/heroku@x.y node: circleci/node@x.y workflows: test-and-deploy: jobs:

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 version: '2.1' orbs: node: circleci/node@x.y workflows: run-npm-command: jobs:

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:

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:

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:

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:

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 version: '2.1' orbs: node: circleci/node@x.y workflows: test: jobs:

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:

Jobs run

Simple drop-in job to run commands for your Node.js application automatically. Show Job Source PARAMETER DEFAULT app-dir Path to the directory containing your package.json file. Not needed if package.json lives in the root. ~/project type: string cache-version Change the default cache version if you need to clear the cache for any reason. v1 type: string npm-run The name of the script within your package.json which you would like to run. '' type: 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. '' type: string pkg-manager Select the default node package manager to use. npm type: enum resource_class Configure the executor resource class large type: enum 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. [] type: steps version Pick a specific cimg/node image version tag: https://hub.docker.com/r/cimg/node lts type: string yarn-run The name of the script within your package.json which you would like to run. '' type: string test

Simple drop-in job to test your Node.js application automatically. Show Job Source PARAMETER DEFAULT app-dir Path to the directory containing your package.json file. Not needed if package.json lives in the root. ~/project type: string cache-version Change the default cache version if you need to clear the cache for any reason. v1 type: 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. '' type: string pkg-manager Select the default node package manager to use. npm type: enum resource_class Configure the executor resource class large type: enum run-command The name of the script within your package.json which will run your tests. test type: 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. [] type: steps 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. other type: 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. '' type: string version Pick a specific cimg/node image version tag: https://hub.docker.com/r/cimg/node lts type: string Commands install

Install custom versions of Node.js, and optionally NPM/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 DEFAULT install-yarn Install Yarn? false type: boolean node-install-dir Where should Node.js be installed? /usr/local type: string 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 will be installed. If no .nvmrc 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 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 '' type: string install-packages

Install your Node packages with automated caching and best practices applied. Requires lock file. Show Command Source PARAMETER DEFAULT app-dir Path to the directory containing your package.json file. Not needed if package.json lives in the root. . type: 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. true type: boolean cache-path By default, this orb will utilize 'npm ci' and cache the '~/.npm' directory. Override which path to cache with this parameter. '' type: string cache-version Change the default cache version if you need to clear the cache for any reason. v1 type: 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. never type: enum include-branch-in-cache-key If true, this cache bucket will only apply to jobs within the same branch. true type: boolean override-ci-command By default, packages will be installed with "npm ci", "yarn install --frozen-lockfile" or "yarn install --immutable". Optionally supply a custom package installation command, with any additional flags needed. '' type: string pkg-manager Select the default node package manager to use. NPM v5+ Required. npm type: enum with-cache Cache your node packages automatically for faster install times. true type: boolean install-yarn

Install a custom version of the Yarn package manager Show Command Source PARAMETER DEFAULT 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 '' type: 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 DEFAULT resource_class Configure the executor resource class large type: enum tag Pick a specific cimg/node image version tag: https://hub.docker.com/r/cimg/node lts type: 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

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/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-yarn:
            default: false
            description: Install Yarn?
            type: boolean
        node-install-dir:
            default: /usr/local
            description: |
                Where should Node.js be installed?
            type: string
        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 will be installed. If no .nvmrc 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
        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:
        - 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 \"$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 \"$NODE_PARAM_VERSION\"\n    nvm alias default \"$NODE_PARAM_VERSION\"\nelif [ -f \".nvmrc\" ]; then\n    NVMRC_SPECIFIED_VERSION=$(<.nvmrc)\n    nvm install \"$NVMRC_SPECIFIED_VERSION\"\n    nvm alias default \"$NVMRC_SPECIFIED_VERSION\"\nelse\n    nvm install --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.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.
            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: true
            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" or "yarn install --immutable".
                Optionally supply a custom package installation command, with any additional flags needed.
            type: string
        pkg-manager:
            default: npm
            description: Select the default node package manager to use. NPM v5+ Required.
            enum:
                - npm
                - yarn
                - yarn-berry
            type: enum
        with-cache:
            default: true
            description: Cache your node packages automatically for faster install times.
            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: << parameters.with-cache >>
            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
                        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" ]]; 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: << 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:
                                        - ~/.npm
        - 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

                        # 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

                                yarn install --immutable --immutable-cache "$@"

                                if [[ "$PARAM_CHECK_CACHE" == "detect" && -n "$ENABLE_CHECK_CACHE" ]]; then
                                    cp yarn.lock "$YARN_LOCKFILE_PATH"
                                fi
                            else
                                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-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
                        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
                        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:

Developer Updates Get tips to optimize your builds Or join our research panel and give feedback

Subscribe By submitting this form, you are agreeing to ourTerms of UseandPrivacy Policy. Developer

Terms of UsePrivacy PolicyCookie PolicySecurity © 2024 Circle Internet Services, Inc., All Rights Reserved. CircleCI Developer Hub - circleci/node

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:

Supporting Documentation Links: https://terraqueing.com:2083/