Test suite (#1)

* Added integration test
* Added input for package.yaml location
* Updated README.md to explain the new package-yaml-path input
* Fixed description in action.yml
* Added status badge for tests

Author: webdevred

.github/workflows/build-and-release.yaml

@@ -13,11 +13,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v4.2.2
         with:
           fetch-depth: 0
       - name: Set up Node.js
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v4.4.0
         with:
           node-version: '20'
       - name: Install dependencies
@@ -38,7 +38,7 @@ jobs:
           git push origin ${{ github.event.inputs.tag }}
       - name: Create GitHub release
         id: create_release
-        uses: softprops/action-gh-release@v2
+        uses: softprops/action-gh-release@v2.3.2
         with:
           tag_name: ${{ github.event.inputs.tag }}
           generate_release_notes: true

.github/workflows/test.yaml

@@ -0,0 +1,26 @@
+name: Test Get Supported GHC Version Action
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+  schedule:
+    - cron: 0 5 * * 0  # every sunday 05:00 UTC
+
+jobs:
+  integration-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+      - run: npm install
+      - run: npm run build
+      - name: Run action
+        uses: ./
+        with:
+          package-yaml-path: examples/package.yaml
+        id: ghc-version
+      - name: Assert output
+        run: |-
+          if [ "${{ steps.ghc-version.outputs.ghc-version }}" != "8.10.7" ]; then
+            exit 1
+          fi

README.md

@@ -1,9 +1,23 @@
 # Get Supported GHC Version
 
+[![Test Get Supported GHC Version Action](https://github.com/webdevred/get-supported-ghc/actions/workflows/test.yaml/badge.svg)](https://github.com/webdevred/get-supported-ghc/actions/workflows/test.yaml)
+
 This GitHub Action automatically detects the latest GHC (Glasgow Haskell Compiler) version compatible with your Haskell project's `base` dependency constraint in `package.yaml`.
 
 Useful for CI/CD workflows where you want to install a GHC version that satisfies your project's dependency bounds.
 
+## Inputs
+
+| Input               | Description                                                | Default        | Required |
+|---------------------|------------------------------------------------------------|----------------|----------|
+| `package-yaml-path` | Path to your `package.yaml` file relative to the repo root | `package.yaml` | No       |
+
+## Outputs
+
+| Output        | Description                                  |
+|---------------|----------------------------------------------|
+| `ghc-version` | The latest compatible GHC version to install |
+
 ## Example Usage
 
 ```yaml
@@ -21,6 +35,8 @@ jobs:
       - name: Get latest supported GHC version
         id: get-ghc
         uses: webdevred/[email protected]
+        with:
+          package-yaml-path: examples/package.yaml
       - name: Set up GHC latest and Cabal
         id: setup-ghc
         uses: haskell-actions/[email protected]

action.yml

@@ -1,11 +1,17 @@
 name: Get Supported GHC Version
 description: Finds the latest GHC version that supports the base upper bound in your
-  .cabal file.
+  package.yaml file.
 
 runs:
   using: node20
   main: index.js
 
+inputs:
+  package-yaml-path:
+    description: 'Path to package.yaml (default: package.yaml in repo root)'
+    required: false
+    default: package.yaml
+
 outputs:
   ghc-version:
     description: The GHC version to install

examples/package.yaml

@@ -0,0 +1,8 @@
+name: my-haskell-package
+version: 0.1.0.0
+dependencies: [base >= 4.10 && < 4.15, containers, text]
+
+library:
+  exposed-modules: MyLib
+  source-dirs: src
+  ghc-options: -Wall

src/index.js

@@ -2,6 +2,7 @@ const { exec } = require("child_process");
 const fs = require("fs");
 const path = require("path");
 const yaml = require("js-yaml");
+const githubCore = require("@actions/core");
 
 async function runCommand(cmd) {
   return new Promise((resolve, reject) => {
@@ -49,8 +50,9 @@ function versionLess(v1, v2) {
 async function main() {
   try {
     const files = fs.readdirSync(process.cwd());
+    const packageYamlPath = githubCore.getInput("package-yaml-path") || path.join(process.cwd(), "package.yaml");
 
-    const baseUpperBound = getBaseUpperBound(path.join(process.cwd(), "package.yaml"));
+    const baseUpperBound = getBaseUpperBound(packageYamlPath);
 
     const ghcupListStr = await runCommand("ghcup list -t ghc -r");
     const lines = ghcupListStr.split("\n").filter(Boolean);
@@ -61,6 +63,12 @@ async function main() {
           return { version: match[1], base: match[2] };
       }).filter(Boolean);
 
+      if(ghcupList.length > 0) {
+          console.log(`Found ${ghcupList.length} GHC versions`);
+      } else {
+          throw new Error('Failed to get GHC versions from GHCup');
+      }
+
     const validVersions = ghcupList.filter(ghcEntry => {
       return versionLess(ghcEntry.base, baseUpperBound);
     });