fix: setup-jikkou.js

Author: fhussonnois

.github/workflows/setup-jikkou.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
-        jikkou-versions: [0.27.0, latest]
+        jikkou-versions: [0.27.0, 0.28.0, latest]
 
     steps:
       - name: Checkout GitHub repository
@@ -29,11 +29,12 @@ jobs:
         uses: ./
         with:
           jikkou_version: ${{ matrix['jikkou-versions'] }}
+          jikkou_config: ./config/jikkouconfig.json
 
       - name: Validate Jikkou Version - ${{ matrix['jikkou-versions'] }}
         if: ${{ matrix['jikkou-versions'] != 'latest' }}
         run: jikkou -V | grep ${{ matrix['jikkou-versions']}}
 
       - name: Validate Jikkou Version - ${{ matrix['jikkou-versions'] }}
         if: ${{ matrix['jikkou-versions'] == 'latest' }}
-        run: jikkou -V | grep 'Jikkou version'
+        run: jikkou -V | grep 'Jikkou version'

.gitignore

@@ -0,0 +1,2 @@
+/node_modules/
+/.idea/

README.md

@@ -1,9 +1,12 @@
 # setup-jikkou
 
-The `streamthoughts/setup-jikkou` action is a JavaScript action that sets up Jikkou CLI in your **GitHub Actions** workflow
+The `streamthoughts/setup-jikkou` action is a JavaScript action that sets
+up [Jikkou CLI](https://github.com/streamthoughts/jikkou) in your **GitHub Actions**
+workflow
 by:
 
 * Downloading a specific version of **Jikkou CLI** and adding it to the `PATH`.
+* Configuring **JIKKOU CLI** with a custom configuration file.
 
 After you've used the action, subsequent steps in the same job can run arbitrary Jikkou commands using the GitHub
 Actions run syntax. This allows most Jikkou commands to work exactly like they do on your local command line.
@@ -12,18 +15,36 @@ Actions run syntax. This allows most Jikkou commands to work exactly like they d
 
 ```yaml
 steps:
-- uses: streamthoughts/setup-jikkou@v1
+  - uses: streamthoughts/setup-jikkou@v1
 ```
 
 A specific version of Jikkou CLI can be installed:
 
 ```yaml
 steps:
-- uses: streamthoughts/setup-jikkou@v1
-  with:
-    jikkou_version: 0.28.0
+  - uses: streamthoughts/setup-jikkou@v0.1.0
+    with:
+      jikkou_version: 0.28.0
 ```
 
+A custom configuration file can be specified:
+
+```yaml
+steps:
+  - uses: streamthoughts/setup-jikkou@v0.1.0
+    with:
+      jikkou_config: ./config/jikkouconfig.json
+```
+
+## Inputs
+
+This Action additionally supports the following inputs :
+
+| Property	        | Default  | Description                                                                                                                    |
+|------------------|----------|--------------------------------------------------------------------------------------------------------------------------------|
+| `jikkou_version` | `latest` | The version of Jikkou CLI to install. A value of `latest` will install the latest version of Jikkou CLI.                       |
+| `jikkou_config`  |          | The path to the Jikkou CLI config file. If set, Jikkou CLI will be configured through the `JIKKOUCONFIG` environment variable. |
+
 ## License
 
 This code base is available under the Apache License, version 2.

action.yaml

@@ -6,6 +6,9 @@ inputs:
     description: 'The version of Jikkou CLI to install. A value of `latest` will install the latest version of Jikkou CLI. Defaults to `latest`.'
     default: 'latest'
     required: false
+  jikkou_config:
+    description: 'The path to the Jikkou CLI config file. If set, Jikkou CLI will be configured through the `JIKKOUCONFIG` environment variable.'
+    required: false
 runs:
   using: 'node20'
   main: 'dist/index.js'

config/jikkouconfig.json

@@ -0,0 +1,6 @@
+{
+  "currentContext": "github-action",
+  "github-action": {
+    "configProps": {}
+  }
+}

dist/index.js

@@ -10,24 +10,20 @@
  */
 
 // Node.js core
-const fs = (__nccwpck_require__(7147).promises);
+const fs = __nccwpck_require__(7147);
 const os = __nccwpck_require__(2037);
 const path = __nccwpck_require__(1017);
 
 // Github toolkit
 const core = __nccwpck_require__(2186);
 const github = __nccwpck_require__(5438);
 const tc = __nccwpck_require__(7784);
-
 const http = __nccwpck_require__(6255);
 
-const project = {
-  owner: "streamthoughts",
-  repo: "jikkou",
-};
+const project = { owner: "streamthoughts", repo: "jikkou" };
 
 async function downloadCLI(url) {
-  core.debug(`Downloading Jikkou CLI from ${url}`);
+  core.info(`Downloading Jikkou CLI from ${url}`);
   const pathToCLIZip = await tc.downloadTool(url);
 
   let pathToCLI = "";
@@ -43,27 +39,27 @@ async function downloadCLI(url) {
     pathToCLI = await tc.extractZip(pathToCLIZip);
   }
 
-  core.debug(`Jikkou CLI path is ${pathToCLI}.`);
-
   if (!pathToCLIZip || !pathToCLI) {
     throw new Error(`Unable to download Jikkou from ${url}`);
   }
-
   return pathToCLI;
 }
 
-// arch in [arm, x32, x64...] (https://nodejs.org/api/os.html#os_os_arch)
+// arch in [arm, x32, x64...]
+// (https://nodejs.org/api/os.html#os_os_platform)
 function mapArch(arch) {
   const mappings = {
     x64: "x86_64",
   };
   return mappings[arch] || arch;
 }
 
-// os in [darwin, linux, win32...] (https://nodejs.org/api/os.html#os_os_platform)
+// os in [darwin, linux, win32...]
+// (https://nodejs.org/api/os.html#os_os_platform)
 function mapOS(os) {
   const mappings = {
     win32: "windows",
+    darwin: "osx",
   };
   return mappings[os] || os;
 }
@@ -76,8 +72,9 @@ async function getReleaseVersion(version) {
     },
   });
 
-  const url = `https://api.github.com/repos/${project.owner}/${project.repo}/releases/${version}`;
-  const res = await _http.get(url);
+  const res = await _http.get(
+    `https://api.github.com/repos/${project.owner}/${project.repo}/releases/${version}`,
+  );
   const body = await res.readBody();
   const response = JSON.parse(body);
   return response;
@@ -90,24 +87,34 @@ async function findLatestReleaseVersion() {
 
 async function getBuild(version, platform, arch) {
   const response = await getReleaseVersion(`tags/v${version}`);
+  if (!response || !response.assets) return null;
+
   const asset = response.assets.find((asset) =>
     asset.name.includes(`jikkou-${version}-${platform}-${arch}.zip`),
   );
-  return !asset ? null : { url: `${asset.browser_download_url}` };
+  return !asset
+    ? null
+    : {
+        name: `${asset.name}`,
+        url: `${asset.browser_download_url}`,
+        created_at: `${asset.created_at}`,
+        size: `${asset.size}`,
+      };
 }
 
 async function run() {
   try {
     // Gather GitHub Actions inputs
     const inputVersion = core.getInput("jikkou_version") || "latest";
+    const inputConfig = core.getInput("jikkou_config");
 
     // Gather OS details
     const osPlatform = os.platform();
     const osArch = os.arch();
     core.debug(`OS: {platform:"${osPlatform}", arch: "${osArch}"}`);
 
     // Gather Release
-    core.debug(`Finding releases for Jikkou version "${inputVersion}"`);
+    core.info(`Finding releases for Jikkou version "${inputVersion}"`);
     const platform = mapOS(osPlatform);
     const arch = mapArch(osArch);
 
@@ -116,22 +123,42 @@ async function run() {
       version = await findLatestReleaseVersion();
     }
 
-    core.debug(
+    core.info(
       `Getting build for Jikkou version ${version}: ${platform} ${arch}`,
     );
+
     const build = await getBuild(version, platform, arch);
     if (!build) {
       throw new Error(
         `Jikkou version ${version} not available for ${platform} and ${arch}`,
       );
     }
-    core.debug(build);
-
     // Download requested version
-    const pathToCLI = await downloadCLI(build.url);
+    const pathToCLIDirectory = await downloadCLI(build.url);
 
     // Add to path
+    const pathToCLI = path.resolve(
+      [pathToCLIDirectory, build.name.replace(".zip", ""), "bin"].join(
+        path.sep,
+      ),
+    );
+    core.info(`Jikkou CLI path is ${pathToCLI}`);
     core.addPath(pathToCLI);
+
+    if (inputConfig) {
+      const pathToConfigFile = path.resolve(inputConfig);
+      core.info(`Set environment variable JIKKOUCONFIG=${pathToConfigFile}`);
+      core.exportVariable("JIKKOUCONFIG", pathToConfigFile);
+    }
+
+    const release = {
+      version: version,
+      name: build.name,
+      url: build.url,
+      created_at: build.created_at,
+      size: build.size,
+    };
+
     return release;
   } catch (error) {
     core.error(error);