@factorialco/gat 0.0.2 → 0.0.5

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 import { Workflow } from "./workflow";
-import { RunStep, UseStep, ConcurrencyGroup, JobOptions, Matrix, Service } from "./job";
-export { Workflow, RunStep, UseStep, ConcurrencyGroup, JobOptions, Matrix, Service, };
+import { ConcurrencyGroup, JobOptions, Matrix, Service } from "./job";
+import { RunStep, UseStep, BaseStep } from "./step";
+export { Workflow, RunStep, UseStep, BaseStep, ConcurrencyGroup, JobOptions, Matrix, Service, };

package/dist/job.d.ts

@@ -1,73 +1,3 @@
-declare type Step = RunStep | {
-    [Name in ActionName]: UseStep<Name>;
-}[ActionName];
-interface BaseStep {
-    id?: string;
-    name?: string;
-    env?: Record<string, string>;
-    ifExpression?: string;
-    workingDirectory?: string;
-}
-export interface RunStep extends BaseStep {
-    run: string;
-}
-declare type ActionName = "actions/checkout@v3" | "actions/setup-node@v3" | "actions/upload-artifact@v3" | "actions/download-artifact@v3" | "ruby/setup-ruby@v1" | "dorny/paths-filter@v2" | "tespkg/actions-cache@v1" | "prewk/s3-cp-action@v2" | "chromaui/action@v1" | "rtCamp/action-slack-notify@v2" | "factorialco/delta-action@v3.0.0" | "factorialco/test-summary-action@v1.2.0";
-export interface UseStep<T extends ActionName> extends BaseStep {
-    uses: T;
-    with?: StepOptions<T>;
-}
-declare type StepOptions<T extends ActionName> = T extends "actions/checkout@v3" ? {
-    ref?: string;
-    "fetch-depth"?: number;
-} : T extends "actions/setup-node@v3" ? {
-    "node-version": string;
-} : T extends "actions/upload-artifact@v3" ? {
-    name: string;
-    path: string;
-} : T extends "ruby/setup-ruby@v1" ? {
-    "ruby-version": string;
-    "cache-version"?: number;
-    "bundler-cache"?: boolean;
-    "working-directory"?: string;
-} : T extends "dorny/paths-filter@v2" ? {
-    filters: string;
-} : T extends "tespkg/actions-cache@v1" ? {
-    endpoint: string;
-    region: string;
-    bucket: string;
-    accessKey: string;
-    secretKey: string;
-    insecure: string;
-    "use-fallback": boolean;
-    path: string;
-    key: string;
-    "restore-keys": string;
-} : T extends "prewk/s3-cp-action@v2" ? {
-    source: string;
-    dest: string;
-    aws_s3_endpoint: string;
-    aws_region: string;
-    aws_access_key_id: string;
-    aws_secret_access_key: string;
-} : T extends "chromaui/action@v1" ? {
-    workingDir: string;
-    token: string;
-    projectToken: string;
-    exitZeroOnChanges?: boolean;
-    autoAcceptChanges?: boolean;
-} : T extends "factorialco/delta-action@v3.0.0" ? {
-    engine: "eslint" | "semgrep" | "rubocop";
-    main: string;
-    branch: string;
-    head_ref: string;
-    forkpoint: string;
-    monorepo_prefix: "frontend" | "backend";
-} : T extends "factorialco/test-summary-action@v1.2.0" ? {
-    engine: "jest" | "rspec";
-    reportFile: string;
-    sha: string;
-} : never;
-declare type Runner = "standard" | "beefy" | "large" | "release" | "standard-aws" | "beefy-aws" | "large-aws" | "release-aws";
 export interface ConcurrencyGroup {
     groupSuffix: string;
     cancelPrevious: boolean;
@@ -75,9 +5,9 @@ export interface ConcurrencyGroup {
 export interface Matrix {
     elements: Array<{
         id: string;
-        options: any[];
+        options: Array<string | number | boolean>;
     }>;
-    extra?: Array<Record<string, any>>;
+    extra?: Array<Record<string, string | number | boolean>>;
 }
 export interface Service {
     image: string;
@@ -89,11 +19,11 @@ export interface Service {
     ports: string[];
     options?: string;
 }
-export interface JobOptions<JobNames = never> {
+export interface JobOptions<Step, Runner, Name> {
     ifExpression?: string;
     runsOn?: Runner;
     timeout?: number;
-    dependsOn?: Array<JobNames>;
+    dependsOn?: Array<Name>;
     services?: Record<string, Service>;
     env?: Record<string, string>;
     concurrency?: ConcurrencyGroup;
@@ -101,8 +31,7 @@ export interface JobOptions<JobNames = never> {
     steps: Step[];
     outputs?: Record<string, string>;
 }
-export interface Job<JobNames> {
+export interface Job<Step, Runner, Name> {
     name: string;
-    options: JobOptions<JobNames>;
+    options: JobOptions<Step, Runner, Name>;
 }
-export {};

package/dist/step.d.ts

@@ -0,0 +1,15 @@
+export interface BaseStep {
+    id?: string;
+    name?: string;
+    env?: Record<string, string>;
+    ifExpression?: string;
+    workingDirectory?: string;
+}
+export declare type Step = RunStep | UseStep;
+export interface RunStep extends BaseStep {
+    run: string;
+}
+export interface UseStep extends BaseStep {
+    uses: string;
+    with?: Record<string, string | number | boolean>;
+}

package/dist/step.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/workflow.d.ts

@@ -1,5 +1,7 @@
 import { Job, JobOptions } from "./job";
 import type { Event, EventName, EventOptions } from "./event";
+import { BaseStep, Step } from "./step";
+declare const DEFAULT_RUNNERS: string[];
 interface DefaultOptions {
     workingDirectory: string;
 }
@@ -7,18 +9,19 @@ interface EnvVar {
     name: string;
     value: string;
 }
-export declare class Workflow<JobNames = never> {
+export declare class Workflow<JobStep extends BaseStep = Step, Runner = typeof DEFAULT_RUNNERS, JobName = never> {
     name: string;
     events: Event[];
-    jobs: Array<Job<JobNames>>;
+    jobs: Array<Job<JobStep, Runner, JobName>>;
     defaultOptions: DefaultOptions | null;
     env: EnvVar[];
     constructor(name: string);
     on<T extends EventName>(name: T, options?: EventOptions<T>): this;
     addDefaults(options: DefaultOptions): this;
-    addJob<JobName extends string>(name: JobName, options: JobOptions<JobNames>): Workflow<JobNames | JobName>;
-    addMergeGatekeeperJob(dependsOn: Array<JobNames>): this;
-    setEnv(name: string, value: any): this;
+    addJob<T extends string>(name: T, options: JobOptions<JobStep, Runner, JobName>): Workflow<JobStep, Runner, JobName | T>;
+    setEnv(name: string, value: string): this;
+    defaultRunner(): string;
+    private assignRunner;
     compile(): string;
 }
 export {};

package/dist/workflow.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Workflow = void 0;
 const yaml_1 = require("yaml");
 const kebabCase_1 = __importDefault(require("lodash/kebabCase"));
+const DEFAULT_RUNNERS = ["ubuntu-22.04"];
 class Workflow {
     constructor(name) {
         this.name = name;
@@ -26,31 +27,18 @@ class Workflow {
         this.jobs = [...this.jobs, { name, options }];
         return this;
     }
-    addMergeGatekeeperJob(dependsOn) {
-        this.jobs = [
-            ...this.jobs,
-            {
-                name: "merge_gatekeeper",
-                options: {
-                    ifExpression: "${{ always() }}",
-                    dependsOn,
-                    steps: [
-                        {
-                            workingDirectory: "${{ github.workspace }}",
-                            run: dependsOn
-                                .map((jobName) => `\${{ needs.${jobName}.result == 'success' || needs.${jobName}.result == 'skipped' }}`)
-                                .join(" && "),
-                        },
-                    ],
-                },
-            },
-        ];
-        return this;
-    }
     setEnv(name, value) {
         this.env = [...this.env, { name, value }];
         return this;
     }
+    defaultRunner() {
+        return "ubuntu-22.04";
+    }
+    assignRunner(runsOn) {
+        const runnerName = runsOn ?? this.defaultRunner();
+        const isSelfHosted = !DEFAULT_RUNNERS.includes(runnerName);
+        return isSelfHosted ? ["self-hosted", runnerName] : runnerName;
+    }
     compile() {
         const result = {
             name: this.name,
@@ -69,7 +57,7 @@ class Workflow {
                 name,
                 {
                     if: ifExpression,
-                    "runs-on": ["self-hosted", `${runsOn ?? "standard-aws"}-runner`],
+                    "runs-on": this.assignRunner(runsOn),
                     "timeout-minutes": timeout ?? 15,
                     needs: dependsOn,
                     services,

package/dist/workflow.spec.js

@@ -8,11 +8,9 @@ const workflow_1 = require("./workflow");
         workflow
             .on("pull_request", { types: ["opened"] })
             .addJob("job1", {
-            runsOn: "standard",
             steps: [{ name: "Do something", run: "exit 0" }],
         })
             .addJob("job2", {
-            runsOn: "standard",
             steps: [{ name: "Do something else", run: "exit 0" }],
             dependsOn: ["job1"],
         });
@@ -24,7 +22,6 @@ const workflow_1 = require("./workflow");
             .on("push", { branches: ["main"] })
             .on("pull_request", { types: ["opened"] })
             .addJob("job1", {
-            runsOn: "standard",
             steps: [{ name: "Do something", run: "exit 0" }],
         });
         (0, vitest_1.expect)(workflow.compile()).toMatchSnapshot();
@@ -37,7 +34,6 @@ const workflow_1 = require("./workflow");
             workingDirectory: "frontend",
         })
             .addJob("job1", {
-            runsOn: "standard",
             steps: [{ name: "Do something", run: "exit 0" }],
         });
         (0, vitest_1.expect)(workflow.compile()).toMatchSnapshot();
@@ -47,9 +43,8 @@ const workflow_1 = require("./workflow");
         workflow
             .on("push")
             .setEnv("NODE_VERSION", "16")
-            .setEnv("ENABLED", true)
+            .setEnv("ENABLED", "true")
             .addJob("job1", {
-            runsOn: "standard",
             steps: [
                 {
                     name: "Do something",
@@ -59,29 +54,9 @@ const workflow_1 = require("./workflow");
         });
         (0, vitest_1.expect)(workflow.compile()).toMatchSnapshot();
     });
-    (0, vitest_1.it)("allows uses steps", () => {
-        const workflow = new workflow_1.Workflow("Uses steps");
-        workflow
-            .on("push")
-            .setEnv("NODE_VERSION", "16")
-            .setEnv("ENABLED", true)
-            .addJob("job1", {
-            runsOn: "standard",
-            steps: [
-                {
-                    uses: "actions/checkout@v3",
-                    with: {
-                        ref: "main",
-                    },
-                },
-            ],
-        });
-        (0, vitest_1.expect)(workflow.compile()).toMatchSnapshot();
-    });
     (0, vitest_1.it)("allows using a concurrency group", () => {
         const workflow = new workflow_1.Workflow("Concurrency group");
         workflow.on("push").addJob("job1", {
-            runsOn: "standard",
             concurrency: {
                 groupSuffix: "foo",
                 cancelPrevious: true,
@@ -97,7 +72,6 @@ const workflow_1 = require("./workflow");
     (0, vitest_1.it)("allows using outputs", () => {
         const workflow = new workflow_1.Workflow("Using outputs");
         workflow.on("push").addJob("job1", {
-            runsOn: "standard",
             steps: [
                 {
                     id: "random-number",
@@ -152,4 +126,40 @@ const workflow_1 = require("./workflow");
         });
         (0, vitest_1.expect)(workflow.compile()).toMatchSnapshot();
     });
+    (0, vitest_1.it)("allows uses steps", () => {
+        const workflow = new workflow_1.Workflow("Uses steps");
+        workflow
+            .on("push")
+            .setEnv("NODE_VERSION", "16")
+            .setEnv("ENABLED", "true")
+            .addJob("job1", {
+            steps: [
+                {
+                    uses: "actions/checkout@v3",
+                    with: {
+                        ref: "main",
+                    },
+                },
+            ],
+        });
+        (0, vitest_1.expect)(workflow.compile()).toMatchSnapshot();
+    });
+    (0, vitest_1.it)("allows custom types in a workflow", () => {
+        const workflow = new workflow_1.Workflow("With custom types");
+        workflow.on("push").addJob("job1", {
+            runsOn: "standard-runner",
+            steps: [
+                {
+                    run: "echo 'Do something'",
+                },
+                {
+                    uses: "custom-action",
+                    with: {
+                        foo: "bar",
+                    },
+                },
+            ],
+        });
+        (0, vitest_1.expect)(workflow.compile()).toMatchSnapshot();
+    });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@factorialco/gat",
-  "version": "0.0.2",
+  "version": "0.0.5",
   "description": "TODO",
   "bin": {
     "gat": "dist/cli.js"
@@ -15,13 +15,21 @@
     "prepare": "npm run build",
     "prepublishOnly": "vitest run",
     "test": "vitest",
-    "coverage": "vitest run --coverage"
+    "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": {
     "@types/lodash": "^4.14.184",
+    "@typescript-eslint/eslint-plugin": "^5.35.1",
+    "@typescript-eslint/parser": "^5.35.1",
     "commander": "^9.4.0",
+    "eslint": "^8.23.0",
+    "eslint-config-prettier": "^8.5.0",
+    "prettier": "2.7.1",
     "typescript": "^4.7.4",
     "vitest": "^0.18.1"
   },