Fix nvm availability check for GHA and update docs.

Closes #79
moodlehq · Feb 2, 2021 · 728ab73 · 728ab73
1 parent 04f57bf
commit 728ab73
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 3 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -82,6 +82,8 @@ jobs:
         echo "TRAVIS_BUILD_DIR="$(cd ../moodle-local_travis; pwd) >> $GITHUB_ENV
         # PHPUnit depends on en_AU.UTF-8 locale
         sudo locale-gen en_AU.UTF-8
+        # Define NVM_DIR pointing to nvm installation.
+        echo "NVM_DIR=$HOME/.nvm" >> $GITHUB_ENV
 
     - name: Install moodle-plugin-ci
       run: moodle-plugin-ci install -vvv

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -9,7 +9,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 The format of this change log follows the advice given at [Keep a CHANGELOG](http://keepachangelog.com).
 
 ## [Unreleased]
-No unreleased changes.
+### Fixed
+- `nvm` availability check to make it work correctly in GHA
+- ACTION REQUIRED: If you are using GitHub Actions, add `NVM_DIR` definition
+  in "Initialise moodle-plugin-ci" step. Without it `nvm` can't be used for
+  node version switching, see the step definition at
+  [gha.dist.yml](https://github.com/moodlehq/moodle-plugin-ci/blob/master/gha.dist.yml)
+  and add missing `NVM_DIR` line your plugin's GHA workflow file.
+
 
 ## [3.0.4] - 2021-01-29
 ### Fixed

diff --git a/docs/GHAFileExplained.md b/docs/GHAFileExplained.md
@@ -92,13 +92,14 @@ jobs:
           coverage: none
 
       # Install this project into a directory called "ci", updating PATH and
-      # locale.
+      # locale, define nvm location.
       - name: Initialise moodle-plugin-ci
         run: |
           composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^3
           echo $(cd ci/bin; pwd) >> $GITHUB_PATH
           echo $(cd ci/vendor/bin; pwd) >> $GITHUB_PATH
           sudo locale-gen en_AU.UTF-8
+          echo "NVM_DIR=$HOME/.nvm" >> $GITHUB_ENV
 
       # Run the default install.
       # Optionally, it is possible to specify a different Moodle repo to use

diff --git a/gha.dist.yml b/gha.dist.yml
@@ -49,6 +49,7 @@ jobs:
           echo $(cd ci/bin; pwd) >> $GITHUB_PATH
           echo $(cd ci/vendor/bin; pwd) >> $GITHUB_PATH
           sudo locale-gen en_AU.UTF-8
+          echo "NVM_DIR=$HOME/.nvm" >> $GITHUB_ENV
 
       - name: Install moodle-plugin-ci
         run: |

diff --git a/src/Installer/VendorInstaller.php b/src/Installer/VendorInstaller.php
@@ -102,7 +102,7 @@ public function stepCount()
      */
     public function canInstallNode()
     {
-        return getenv('NVM_DIR') && getenv('NVM_BIN');
+        return !empty(getenv('NVM_DIR'));
     }
 
     /**
-Original file line number
+Diff line change
@@ Expand Up / @@ -102,7 +102,7 @@ public function stepCount() @@
          */
         public function canInstallNode()
         {
-            return getenv('NVM_DIR') && getenv('NVM_BIN');
+            return !empty(getenv('NVM_DIR'));
         }
         /**
@@ Expand Down @@