@factorialco/gat 2.6.0 → 3.0.1

package/dist/job.d.ts

@@ -1,7 +1,7 @@
-export interface ConcurrencyGroup {
+export type ConcurrencyGroup = {
     groupSuffix: string;
     cancelPrevious: boolean;
-}
+};
 export interface Matrix {
     elements: Array<{
         id: string;
@@ -20,23 +20,23 @@ export interface Service {
     options?: string;
     volumes?: string[];
 }
-export interface JobOptions<Step, Runner, Name> {
+export interface JobOptions<Step, RunnerDefinition, Name> {
     prettyName?: string;
     permissions?: object;
     ifExpression?: string;
-    runsOn?: Runner;
+    runsOn?: RunnerDefinition;
     timeout?: number;
     dependsOn?: Array<Name>;
     services?: Record<string, Service>;
     env?: Record<string, string>;
-    concurrency?: ConcurrencyGroup;
+    concurrency?: ConcurrencyGroup | null;
     matrix?: Matrix | string;
     steps: Step[];
     outputs?: Record<string, string>;
     workingDirectory?: string;
 }
 export type StringWithNoSpaces<T> = T extends `${string} ${string}` ? never : T extends ` ${string}` ? never : T extends `${string} ` ? never : T;
-export interface Job<Step, Runner, Name> {
+export interface Job<Step, RunnerDefinition, Name> {
     name: string;
-    options: JobOptions<Step, Runner, Name>;
+    options: JobOptions<Step, RunnerDefinition, Name>;
 }

package/dist/workflow.d.ts

@@ -1,7 +1,6 @@
 import { ConcurrencyGroup, Job, JobOptions, StringWithNoSpaces } from "./job";
 import type { Event, EventName, EventOptions } from "./event";
 import { type Step } from "./step";
-declare const DEFAULT_RUNNERS: string[];
 interface DefaultOptions {
     workingDirectory: string;
 }
@@ -9,21 +8,24 @@ interface EnvVar {
     name: string;
     value: string;
 }
-export declare class Workflow<JobStep extends Step = Step, Runner = typeof DEFAULT_RUNNERS, JobName = never> {
+export type RunnerDefinition = string | {
+    group: string;
+    labels?: string[];
+} | ["self-hosted", string];
+export declare class Workflow<JobStep extends Step = Step, Runner extends RunnerDefinition = RunnerDefinition, JobName = never> {
     name: string;
     events: Event[];
     jobs: Array<Job<JobStep, Runner, JobName>>;
     defaultOptions: DefaultOptions | null;
     env: EnvVar[];
-    concurrencyGroup?: ConcurrencyGroup;
+    concurrencyGroup?: ConcurrencyGroup | null;
     constructor(name: string);
     on<T extends EventName>(name: T, options?: EventOptions<T>): this;
     addDefaults(options: DefaultOptions): this;
     addJob<T extends string>(name: StringWithNoSpaces<T>, options: JobOptions<JobStep, Runner, JobName>): Workflow<JobStep, Runner, JobName | T>;
     setEnv(name: string, value: string): this;
-    setConcurrencyGroup(concurrencyGroup: ConcurrencyGroup): this;
+    setConcurrencyGroup(concurrencyGroup: ConcurrencyGroup | null): this;
     defaultRunner(): string;
-    private assignRunner;
     compile(filepath?: string): Promise<string | void>;
 }
 export {};

package/dist/workflow.js

@@ -12,7 +12,6 @@ const util_1 = require("util");
 const axios_1 = __importDefault(require("axios"));
 const step_1 = require("./step");
 const writeFilePromise = (0, util_1.promisify)(fs_1.default.writeFile);
-const DEFAULT_RUNNERS = ["ubuntu-22.04"];
 const chainAttackCache = {};
 const supplyChainAttack = async (step, enabled = false) => {
     if (!(0, step_1.isUseStep)(step))
@@ -68,11 +67,6 @@ class Workflow {
     defaultRunner() {
         return "ubuntu-22.04";
     }
-    assignRunner(runsOn) {
-        const runnerName = runsOn ?? this.defaultRunner();
-        const isSelfHosted = !DEFAULT_RUNNERS.includes(runnerName);
-        return isSelfHosted ? ["self-hosted", runnerName] : runnerName;
-    }
     async compile(filepath) {
         const result = {
             name: this.name,
@@ -102,7 +96,7 @@ class Workflow {
                     name: prettyName,
                     permissions,
                     if: ifExpression,
-                    "runs-on": this.assignRunner(runsOn),
+                    "runs-on": runsOn ?? this.defaultRunner(),
                     "timeout-minutes": timeout ?? 15,
                     needs: dependsOn,
                     services,

package/dist/workflow.spec.js

@@ -147,7 +147,7 @@ const workflow_1 = require("./workflow");
     (0, vitest_1.it)("allows custom types in a workflow", async () => {
         const workflow = new workflow_1.Workflow("With custom types");
         workflow.on("push").addJob("job1", {
-            runsOn: "standard-runner",
+            runsOn: ["self-hosted", "standard-runner"],
             steps: [
                 {
                     run: "echo 'Do something'",
@@ -243,4 +243,18 @@ exit 0`,
         });
         (0, vitest_1.expect)(await workflow.compile()).toMatchSnapshot();
     });
+    (0, vitest_1.it)("allows creating jobs with concurrency set to null", async () => {
+        const workflow = new workflow_1.Workflow("Without concurrency")
+            .on("push")
+            .addJob("job1", {
+            concurrency: null,
+            steps: [
+                {
+                    name: "Do something",
+                    run: "exit 0",
+                },
+            ],
+        });
+        (0, vitest_1.expect)(await workflow.compile()).toMatchSnapshot();
+    });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@factorialco/gat",
-  "version": "2.6.0",
+  "version": "3.0.1",
   "description": "Write your GitHub Actions workflows using TypeScript",
   "bin": {
     "gat": "dist/cli.js"
@@ -11,16 +11,6 @@
     "dist/**/*"
   ],
   "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "tsc",
-    "prepare": "npm run build",
-    "prepublishOnly": "vitest run",
-    "test": "vitest",
-    "coverage": "vitest run --coverage",
-    "lint": "eslint src/**/*.ts",
-    "format": "prettier --write .",
-    "format:check": "prettier --check ."
-  },
   "author": "David Morcillo <david.morcillo@factorial.co>",
   "license": "ISC",
   "devDependencies": {
@@ -49,5 +39,13 @@
   "bugs": {
     "url": "https://github.com/factorialco/gat/issues"
   },
-  "homepage": "https://github.com/factorialco/gat#readme"
-}
+  "homepage": "https://github.com/factorialco/gat#readme",
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest",
+    "coverage": "vitest run --coverage",
+    "lint": "eslint src/**/*.ts",
+    "format": "prettier --write .",
+    "format:check": "prettier --check ."
+  }
+}