Add run-cabal-gild action by jasagredo · Pull Request #42 · input-output-hk/actions

jasagredo · 2026-03-04T10:46:12Z

No description provided.

Copilot

Pull request overview

Adds a new GitHub Action (run-cabal-gild) intended to check .cabal file formatting using cabal-gild, including a bundled Node20 implementation and its build artifacts.

Changes:

Introduces a new Node-based action (run-cabal-gild) with metadata (action.yml) and implementation (index.js).
Adds npm packaging (package.json / package-lock.json) and a compiled dist/index.js bundle.
Adds repo-level git config for Node artifacts (.gitignore, .gitattributes).

Reviewed changes

Copilot reviewed 6 out of 9 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
run-cabal-gild/package.json	Defines action build script and dependencies for bundling/running.
run-cabal-gild/package-lock.json	Locks npm dependency tree for the new action.
run-cabal-gild/index.js	Implements downloading cabal-gild and running it over `*/.cabal`.
run-cabal-gild/dist/index.js	Bundled runtime JS used by the GitHub Action.
run-cabal-gild/action.yml	Declares action inputs and Node20 entrypoint.
run-cabal-gild/README.md	Documents usage of the new action.
run-cabal-gild/LICENSE.md	Carries forward upstream licensing info for adapted code.
.gitignore	Ignores `node_modules` across the repo.
.gitattributes	Marks the bundled `dist/index.js` as generated for linguist.

Files not reviewed (1)

run-cabal-gild/package-lock.json: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Copilot · 2026-03-04T11:20:06Z

run-cabal-gild/index.js

+    core.setFailed('Failed to fetch releases from the tfausak/cabal-gild repository');
+  }
+
+  if (releases.length === 0) {
+    core.setFailed('No releases found for the tfausak/cabal-gild repository');


getLatestVersion() calls core.setFailed(...) when releases is null/empty, but it does not return/throw, so execution continues and will throw (e.g., releases.length when releases is null, or releases[0] when empty). Convert these into early returns or throw an error so the action fails deterministically with the right message.

Suggested change

core.setFailed('Failed to fetch releases from the tfausak/cabal-gild repository');

}

if (releases.length === 0) {

core.setFailed('No releases found for the tfausak/cabal-gild repository');

const message = 'Failed to fetch releases from the tfausak/cabal-gild repository';

core.setFailed(message);

throw new Error(message);

}

if (releases.length === 0) {

const message = 'No releases found for the tfausak/cabal-gild repository';

core.setFailed(message);

throw new Error(message);

Copilot · 2026-03-04T11:20:07Z

run-cabal-gild/index.js

+    else {
+        core.setFailed("no cabal-gild binary found for platform: " + process.platform);
+    }
+
+    // At this point, cabal_gild_extracted_dir is the cabal-gild binary we just
+    // downloaded, but tool_cache.downloadTool() gives it a random UUID as a
+    // name.  We rename it to `cabal-gild` here.
+    const cabal_gild_binary = path.join(path.dirname(cabal_gild_extracted_binary), 'cabal-gild');


In the non-Linux platform branch you call core.setFailed(...) but do not return/throw. The code then continues and uses cabal_gild_extracted_binary (still undefined), which will throw later and overwrite the original failure reason. After setting failure for an unsupported platform, exit the run() function (or throw) to prevent follow-on errors.

Copilot · 2026-03-04T11:20:07Z

run-cabal-gild/action.yml

+  extra-args:
+    required: false
+    description: >
+      Extra arguments to pass to Fourmolu.


The extra-args input description says it passes arguments to Fourmolu, but this action runs cabal-gild. Update the description to refer to cabal-gild so users aren't misled.

Suggested change

Extra arguments to pass to Fourmolu.

Extra arguments to pass to cabal-gild.

Copilot · 2026-03-04T11:20:07Z

run-cabal-gild/action.yml

+      Directory in which to run cabal-gild.  This also affects how the `pattern`
+      argument is interpretted, with Glob patterns being relative to this
+      `working-directory` argument.


The working-directory input description mentions a pattern argument and contains a spelling error ("interpretted"). There is no pattern input in this action, so the description should be updated to match the actual inputs and "interpreted" spelling.

Suggested change

Directory in which to run cabal-gild. This also affects how the `pattern`

argument is interpretted, with Glob patterns being relative to this

`working-directory` argument.

Directory in which to run cabal-gild. Paths and glob patterns will be

resolved relative to this directory.

Copilot · 2026-03-04T11:20:07Z

run-cabal-gild/action.yml

+      Extra arguments to pass to Fourmolu.
+  version:
+    required: false
+    description: >
+      The version number of cabal-gild to use. Defaults to "latest". Example
+      version numbers -- `0.13.0.0`, `0.10.1.0`, etc. See


The version input examples look like Fourmolu versions (e.g. 0.13.0.0) rather than cabal-gild (README uses 1.7.0.1). This can confuse users; please update the example versions to match cabal-gild releases.

Suggested change

Extra arguments to pass to Fourmolu.

version:

required: false

description: >

The version number of cabal-gild to use. Defaults to "latest". Example

version numbers -- `0.13.0.0`, `0.10.1.0`, etc. See

Extra arguments to pass to cabal-gild.

version:

required: false

description: >

The version number of cabal-gild to use. Defaults to "latest". Example

version numbers -- `1.7.0.1`, `1.6.0.0`, etc. See

Copilot · 2026-03-04T11:20:08Z

run-cabal-gild/package.json

+  "dependencies": {
+    "@actions/core": "^1.2.6",
+    "@actions/exec": "^1.1.1",
+    "@actions/github": "^6.0.0",
+    "@actions/glob": "^0.4.0",
+    "@actions/http-client": "^2.2.0",
+    "@actions/tool-cache": "^2.0.1",
+    "@vercel/ncc": "^0.38.1",
+    "ncc": "^0.3.6"
+  },
+  "devDependencies": {
+    "@vercel/ncc": "^0.38.1"
+  },


dependencies includes both @vercel/ncc and ncc, and @vercel/ncc is also duplicated in devDependencies. The ncc package here is a different (very old) module that drags in deprecated/vulnerable transitive deps; for building this action you typically only need @vercel/ncc as a devDependency. Suggest removing ncc entirely and keeping @vercel/ncc only under devDependencies (and deleting the duplicate entry).

Copilot · 2026-03-04T11:20:08Z

run-cabal-gild/index.js

+       for (const file of files) {
+            await exec.exec(
+                cabal_gild_cached_path,
+                ['--mode=check', '-i', `${file}`]


The extra-args input is parsed into extra_args, but extra_args is never used when invoking cabal-gild, so the input currently has no effect. Either append extra_args to the arguments passed to exec.exec(...) or remove the input/parsing to avoid a misleading configuration option.

Suggested change

['--mode=check', '-i', `${file}`]

['--mode=check', '-i', `${file}`, ...extra_args]

Copilot · 2026-03-04T11:20:08Z

run-cabal-gild/index.js

+      core.info(`${error}`);
+    core.setFailed("cabal-gild detected unformatted files");


The catch handler always sets the failure message to "cabal-gild detected unformatted files", even when the error is unrelated (download failure, bad working directory, unsupported platform, etc.). Preserve the real error by using error?.message (and/or rethrowing) and only use the "unformatted files" message when the cabal-gild exit code indicates formatting issues.

Suggested change

core.info(`${error}`);

core.setFailed("cabal-gild detected unformatted files");

// Log the raw error for debugging

core.info(`${error}`);

// Determine an appropriate failure message

const hasExitCode = typeof error === 'object' && error !== null && 'exitCode' in error;

const exitCode = hasExitCode ? error.exitCode : undefined;

let failureMessage;

if (typeof exitCode === 'number' && exitCode === 1) {

// cabal-gild exit code 1 indicates unformatted files

failureMessage = "cabal-gild detected unformatted files";

} else if (error && typeof error.message === 'string' && error.message.length > 0) {

// Prefer the specific error message when available

failureMessage = error.message;

} else {

// Fallback generic message

failureMessage = "An unexpected error occurred while running cabal-gild";

}

core.setFailed(failureMessage);

Copilot · 2026-03-04T11:20:08Z

run-cabal-gild/action.yml

+  follow-symbolic-links:
+    required: false
+    description: >
+      Whether to follow symbolic links.


follow-symbolic-links is a boolean-like input but (unlike other actions in this repo) it does not declare type: boolean. Consider adding type: boolean (see e.g. base/action.yml and devx/action.yml) to make the metadata consistent and to ensure tooling/UIs treat it as a boolean.

Suggested change

Whether to follow symbolic links.

Whether to follow symbolic links.

type: boolean

Copilot · 2026-03-04T11:20:09Z

run-cabal-gild/package.json

+  "dependencies": {
+    "@actions/core": "^1.2.6",
+    "@actions/exec": "^1.1.1",
+    "@actions/github": "^6.0.0",
+    "@actions/glob": "^0.4.0",
+    "@actions/http-client": "^2.2.0",
+    "@actions/tool-cache": "^2.0.1",
+    "@vercel/ncc": "^0.38.1",


@actions/github is listed as a dependency but is not used anywhere in index.js. Dropping unused action toolkit dependencies reduces supply-chain surface area and keeps the bundled action smaller.

jasagredo force-pushed the js/run-cabal-gild branch from e3397b2 to a02b0b0 Compare March 4, 2026 10:48

Add run-cabal-gild action

e7c4400

jasagredo force-pushed the js/run-cabal-gild branch from a02b0b0 to e7c4400 Compare March 4, 2026 10:49

angerman requested a review from Copilot March 4, 2026 11:15

Copilot started reviewing on behalf of angerman March 4, 2026 11:15 View session

Copilot AI reviewed Mar 4, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add run-cabal-gild action#42

Add run-cabal-gild action#42
jasagredo wants to merge 1 commit intolatestfrom
js/run-cabal-gild

jasagredo commented Mar 4, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 4, 2026

Uh oh!

Copilot AI Mar 4, 2026

Uh oh!

Copilot AI Mar 4, 2026

Uh oh!

Copilot AI Mar 4, 2026

Uh oh!

Copilot AI Mar 4, 2026

Uh oh!

Copilot AI Mar 4, 2026

Uh oh!

Copilot AI Mar 4, 2026

Uh oh!

Copilot AI Mar 4, 2026

Uh oh!

Copilot AI Mar 4, 2026

Uh oh!

Copilot AI Mar 4, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

-    core.setFailed('Failed to fetch releases from the tfausak/cabal-gild repository');
-  }
-  if (releases.length === 0) {
-    core.setFailed('No releases found for the tfausak/cabal-gild repository');
+    const message = 'Failed to fetch releases from the tfausak/cabal-gild repository';
+    core.setFailed(message);
+    throw new Error(message);
+  }
+  if (releases.length === 0) {
+    const message = 'No releases found for the tfausak/cabal-gild repository';
+    core.setFailed(message);
+    throw new Error(message);

	Extra arguments to pass to Fourmolu.
	Extra arguments to pass to cabal-gild.

	['--mode=check', '-i', `${file}`]
	['--mode=check', '-i', `${file}`, ...extra_args]

		core.info(`${error}`);
		core.setFailed("cabal-gild detected unformatted files");

-      core.info(`${error}`);
-    core.setFailed("cabal-gild detected unformatted files");
+    // Log the raw error for debugging
+    core.info(`${error}`);
+    // Determine an appropriate failure message
+    const hasExitCode = typeof error === 'object' && error !== null && 'exitCode' in error;
+    const exitCode = hasExitCode ? error.exitCode : undefined;
+    let failureMessage;
+    if (typeof exitCode === 'number' && exitCode === 1) {
+      // cabal-gild exit code 1 indicates unformatted files
+      failureMessage = "cabal-gild detected unformatted files";
+    } else if (error && typeof error.message === 'string' && error.message.length > 0) {
+      // Prefer the specific error message when available
+      failureMessage = error.message;
+    } else {
+      // Fallback generic message
+      failureMessage = "An unexpected error occurred while running cabal-gild";
+    }
+    core.setFailed(failureMessage);

	Whether to follow symbolic links.
	Whether to follow symbolic links.
	type: boolean

Conversation

jasagredo commented Mar 4, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants