https://github.com/twm/nvm-github-actions-example
Example of using nvm in GitHub Actions
https://github.com/twm/nvm-github-actions-example
Last synced: 8 months ago
JSON representation
Example of using nvm in GitHub Actions
- Host: GitHub
- URL: https://github.com/twm/nvm-github-actions-example
- Owner: twm
- License: mit
- Archived: true
- Created: 2020-12-21T23:52:21.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-01T01:01:37.000Z (over 1 year ago)
- Last Synced: 2025-03-12T23:42:46.543Z (10 months ago)
- Size: 7.81 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
.. This document © 2021 Tom Most. All rights reserved.
.. Code examples provided under the MIT license. See the file LICENSE.
===========================
Using nvm on GitHub Actions
===========================
.. note::
`actions/setup-node` now supports nvm-compatible Node version specifications.
To activate this:
.. code-block:: yaml
- uses: actions/setup-node@v4
with:
node-version-file: ".nvmrc"
This also builds in support for caching — see the `documentation `__.
The original article from 2021 continues below.
GitHub Actions `virtual environments`_ (VM images) `include nvm`_, the `Node Version Manager `_,
the ``nvm`` command doesn't work by default on GitHub Actions (GHA).
This document describes how to get it working,
and demonstrates how to integrate nvm and npm with GHA's handy caching functionality to speed up your builds.
Getting nvm Working
===================
Why doesn't the ``nvm`` command work by default?
Recall that when you `install nvm`_ it adds a snippet to your shell's startup scripts.
For Bash, it's added to ``~/.bash_profile``, which is only sourced (included) as part of *interactive* shell startup [1]_.
A GHA `run step`_ runs Bash with flags that skip sourcing that file, by default::
bash --noprofile --norc -eo pipefail {0}
If you override the ``shell`` command to include the ``--login`` flag Bash will automatically do the sourcing:
.. code-block:: yaml
jobs:
steps:
- run: |
nvm install
shell: "bash -eo pipefail --login {0}"
This is a bit of a mouthful to repeat on each step, but that's what it takes.
Enabling Caching
================
.. TODO
.. _virtual environments: https://github.com/actions/virtual-environments
.. _include nvm: https://github.com/actions/virtual-environments/blob/main/images/linux/scripts/installers/nvm.sh
.. permalink for the above https://github.com/actions/virtual-environments/blob/826fed960459993d41c2f9310d220b7cf2c015e8/images/linux/scripts/installers/nvm.sh
.. _nvm: https://github.com/nvm-sh/nvm
.. _install nvm: https://github.com/nvm-sh/nvm#install--update-script
.. [1] See the `INVOCATION section`_ of ``bash(1)``
.. _invocation section: https://manpages.ubuntu.com/manpages/focal/en/man1/bash.1.html#invocation
.. _run step: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun