Fix #29: new input 'cabal-update: false' to turn off 'cabal update'

haskell · Jan 10, 2023 · fab017e · fab017e
1 parent 074f9de
commit fab017e
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 12 deletions.
diff --git a/setup/action.yml b/setup/action.yml
@@ -16,16 +16,20 @@ inputs:
     default: 'latest'
   enable-stack:
     required: false
-    description: 'If specified, will setup Stack'
+    description: 'If specified, will setup Stack.'
   stack-no-global:
     required: false
-    description: 'If specified, enable-stack must be set. Prevents installing GHC and Cabal globally'
+    description: 'If specified, enable-stack must be set. Prevents installing GHC and Cabal globally.'
   stack-setup-ghc:
     required: false
-    description: 'If specified, enable-stack must be set. Will run stack setup to install the specified GHC'
+    description: 'If specified, enable-stack must be set. Will run stack setup to install the specified GHC.'
+  cabal-update:
+    required: false
+    default: true
+    description: 'Set to false to prevent `cabal update` from being run.'
   disable-matcher:
     required: false
-    description: 'If specified, disables match messages from GHC as GitHub CI annotations'
+    description: 'If specified, disables match messages from GHC as GitHub CI annotations.'
 outputs:
   ghc-path:
     description: 'The path of the ghc executable _directory_'

diff --git a/setup/dist/index.js b/setup/dist/index.js
diff --git a/setup/lib/opts.d.ts b/setup/lib/opts.d.ts
diff --git a/setup/lib/opts.js b/setup/lib/opts.js
diff --git a/setup/lib/setup-haskell.js b/setup/lib/setup-haskell.js
diff --git a/setup/src/opts.ts b/setup/src/opts.ts
@@ -24,7 +24,7 @@ export interface ProgramOpt {
 
 export interface Options {
   ghc: ProgramOpt;
-  cabal: ProgramOpt;
+  cabal: ProgramOpt & {update: boolean};
   stack: ProgramOpt & {setup: boolean};
   general: {matcher: {enable: boolean}};
 }
@@ -93,6 +93,7 @@ export function getOpts(
   const stackSetupGhc = (inputs['stack-setup-ghc'] || '') !== '';
   const stackEnable = (inputs['enable-stack'] || '') !== '';
   const matcherDisable = (inputs['disable-matcher'] || '') !== '';
+  const cabalUpdate = inputs['cabal-update'] !== 'false';
   core.debug(`${stackNoGlobal}/${stackSetupGhc}/${stackEnable}`);
   const verInpt = {
     ghc: inputs['ghc-version'] || ghc.version,
@@ -136,7 +137,8 @@ export function getOpts(
         os,
         cabalEnable // if true: inform user about resolution
       ),
-      enable: cabalEnable
+      enable: cabalEnable,
+      update: cabalUpdate
     },
     stack: {
       raw: verInpt.stack,

diff --git a/setup/src/setup-haskell.ts b/setup/src/setup-haskell.ts
@@ -73,7 +73,7 @@ export default async function run(
           // https://github.com/haskell/cabal/issues/6823
           // await exec('cabal user-config update');
         }
-        if (!opts.stack.enable) await exec('cabal update');
+        if (opts.cabal.update && !opts.stack.enable) await exec('cabal update');
       });
 
     core.info(`##[add-matcher]${path.join(__dirname, '..', 'matcher.json')}`);