Merge branch 'fallback-neovim-stable' into master (fix #5)

.github/workflows/ci.yml

@@ -68,7 +68,10 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
       - run: npm ci
-      - run: npm test
+      - name: Run unit tests
+        run: npm test
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
       - run: npm run lint
       - uses: actions/setup-python@v1
       - run: pip install yamllint

.gitignore

@@ -3,3 +3,4 @@
 /test/*.js
 /scripts/*.js
 *.js.map
+/env.sh

action.yml

@@ -14,13 +14,20 @@ inputs:
     required: false
     default: 'stable'
   neovim:
-    description: 'Setting to true will install Neovim.'
+    description: >
+      Setting to true will install Neovim.
     required: false
     default: false
+  token:
+    description: >
+      Personal access token. It is used for calling GitHub API. The API call happens when Neovim
+      asset is not found and needs to fallback.
+    default: ${{ github.token }}
 
 outputs:
   executable:
-    description: 'Absolute file path to the installed executable'
+    description: >
+      Absolute file path to the installed executable.
 
 runs:
   using: 'node12'

package.json

@@ -34,6 +34,7 @@
   "dependencies": {
     "@actions/core": "^1.2.5",
     "@actions/exec": "^1.0.4",
+    "@actions/github": "^4.0.0",
     "@actions/io": "^1.0.2",
     "node-fetch": "^2.6.1"
   },

src/config.ts

@@ -6,6 +6,7 @@ export interface Config {
     readonly version: string;
     readonly neovim: boolean;
     readonly os: Os;
+    readonly token: string | null;
 }
 
 function getBoolean(input: string, def: boolean): boolean {
@@ -67,5 +68,6 @@ export function loadConfigFromInputs(): Config {
         version: getVersion(neovim),
         neovim,
         os: getOs(),
+        token: getInput('token') ?? null,
     };
 }

src/install_linux.ts

@@ -4,7 +4,7 @@ import type { Installed } from './install';
 import type { Config } from './config';
 import { exec } from './shell';
 import { buildVim } from './vim';
-import { downloadNeovim } from './neovim';
+import { downloadNeovim, downloadStableNeovim } from './neovim';
 
 async function installVimStable(): Promise<Installed> {
     core.debug('Installing stable Vim on Linux using apt');
@@ -25,20 +25,28 @@ async function installVim(ver: string | null): Promise<Installed> {
     };
 }
 
-async function installNeovim(ver: string): Promise<Installed> {
-    core.debug(`Installing Neovim version '${ver}' on Linux`);
-    const nvimDir = await downloadNeovim(ver, 'linux');
+function neovimInstalled(nvimDir: string): Installed {
     return {
         executable: 'nvim',
         binDir: path.join(nvimDir, 'bin'),
     };
 }
 
+async function installNeovim(ver: string): Promise<Installed> {
+    core.debug(`Installing Neovim version '${ver}' on Linux`);
+    return neovimInstalled(await downloadNeovim(ver, 'linux'));
+}
+
+async function installStableNeovim(token: string | null): Promise<Installed> {
+    core.debug(`Installing Neovim version 'stable' on Linux`);
+    return neovimInstalled(await downloadStableNeovim('linux', token));
+}
+
 export function install(config: Config): Promise<Installed> {
     if (config.neovim) {
         switch (config.version) {
             case 'stable':
-                return installNeovim('stable');
+                return installStableNeovim(config.token);
             case 'nightly':
                 return installNeovim('nightly');
             default:

src/install_windows.ts

@@ -3,7 +3,7 @@ import * as core from '@actions/core';
 import type { Installed } from './install';
 import type { Config } from './config';
 import { installNightlyVimOnWindows, installVimOnWindows } from './vim';
-import { downloadNeovim } from './neovim';
+import { downloadNeovim, downloadStableNeovim } from './neovim';
 
 async function installVimNightly(): Promise<Installed> {
     core.debug('Installing nightly Vim on Windows');
@@ -29,20 +29,28 @@ async function installVim(ver: string): Promise<Installed> {
     };
 }
 
-async function installNeovim(ver: string): Promise<Installed> {
-    core.debug(`Installing Neovim version '${ver}' on Windows`);
-    const nvimDir = await downloadNeovim(ver, 'windows');
+function neovimInstalled(nvimDir: string): Installed {
     return {
         executable: 'nvim.exe',
         binDir: path.join(nvimDir, 'bin'),
     };
 }
 
+async function installNeovim(ver: string): Promise<Installed> {
+    core.debug(`Installing Neovim version '${ver}' on Windows`);
+    return neovimInstalled(await downloadNeovim(ver, 'windows'));
+}
+
+async function installStableNeovim(token: string | null): Promise<Installed> {
+    core.debug(`Installing Neovim version 'stable' on Windows`);
+    return neovimInstalled(await downloadStableNeovim('windows', token));
+}
+
 export function install(config: Config): Promise<Installed> {
     if (config.neovim) {
         switch (config.version) {
             case 'stable':
-                return installNeovim('stable');
+                return installStableNeovim(config.token);
             case 'nightly':
                 return installNeovim('nightly');
             default: