@factorialco/gat 0.0.18 → 0.0.20

package/README.md

@@ -1,3 +1,92 @@
-# GitHub Actions Template Generator (aka GAT)
+# gat ![Build](https://github.com/factorialco/gat/actions/workflows/build.yml/badge.svg?branch=main) [![npm version](https://badge.fury.io/js/@factorialco%2Fgat.svg)](https://badge.fury.io/js/@factorialco%2Fgat)
+
+The `gat` project is a tool to **write your GitHub Actions workflows using TypeScript**.
+
+Maintaining YAML files is hard and if your project is big enough you will find yourself duplicating a lot of code between your workflows. With `gat` you can create reusable jobs and steps just using TypeScript objects and importing them in your workflow templates.
+
+_Why `gat`?_ The name is an acronym of "GitHub Actions Template Generator" without the last part because `gat` means "cat" in Catalan.
+
+## Installation
+
+Install the main package and its dependencies using the following command:
+
+```bash
+npm i -D @factorialco/gat typescript ts-node commander
+```
+
+## Usage
+
+### Writing a template
+
+The `gat` CLI assumes that your templates are inside `.github/templates`. Let's create our first template:
+
+```ts
+// .github/templates/my-first-workflow.ts
+import { Workflow } from "@factorialco/gat";
+
+new Workflow("My first workflow")
+  .on("push")
+  .addJob("test", {
+    steps: [
+      {
+        uses: "actions/checkout@v3",
+      },
+      {
+        uses: "actions/setup-node@v3",
+      },
+      {
+        run: "npm test",
+      },
+    ],
+  })
+  .compile();
+```
+
+Notice that you need to call the `compile()` method at the end.
+
+### Compiling your templates
+
+You can build your templates running this command in your root folder:
+
+```bash
+npx gat build
+```
+
+Alternatively you can also compile a single template:
+
+```bash
+npx gat build .github/templates/some-workflow.ts
+```
+
+Following the previous example, you should see now a file `.github/workflows/my-first-workflow.yml` like this:
+
+```yaml
+# Workflow automatically generated by gat
+# DO NOT CHANGE THIS FILE MANUALLY
+
+name: My first workflow
+on:
+  push: null
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+      - run: npm test
+```
+
+Notice that the job includes a few assumptions like the `runs-on` and `timeout-minutes` fields. You can change those when adding a new job.
+
+### Create your own workflow class
+
+TODO
+
+## Contributing
+
+TODO
+
+## License
 
 TODO

package/dist/workflow.d.ts

@@ -1,4 +1,4 @@
-import { Job, JobOptions } from "./job";
+import { ConcurrencyGroup, Job, JobOptions } from "./job";
 import type { Event, EventName, EventOptions } from "./event";
 import { BaseStep, Step } from "./step";
 declare const DEFAULT_RUNNERS: string[];
@@ -15,11 +15,13 @@ export declare class Workflow<JobStep extends BaseStep = Step, Runner = typeof D
     jobs: Array<Job<JobStep, Runner, JobName>>;
     defaultOptions: DefaultOptions | null;
     env: EnvVar[];
+    concurrencyGroup?: ConcurrencyGroup;
     constructor(name: string);
     on<T extends EventName>(name: T, options?: EventOptions<T>): this;
     addDefaults(options: DefaultOptions): this;
     addJob<T extends string>(name: T, options: JobOptions<JobStep, Runner, JobName>): Workflow<JobStep, Runner, JobName | T>;
     setEnv(name: string, value: string): this;
+    setConcurrencyGroup(concurrencyGroup: ConcurrencyGroup): this;
     defaultRunner(): string;
     private assignRunner;
     compile(): string;

package/dist/workflow.js

@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Workflow = void 0;
 const js_yaml_1 = require("js-yaml");
 const kebabCase_1 = __importDefault(require("lodash/kebabCase"));
-const lodash_1 = require("lodash");
 const DEFAULT_RUNNERS = ["ubuntu-22.04"];
 class Workflow {
     constructor(name) {
@@ -32,6 +31,10 @@ class Workflow {
         this.env = [...this.env, { name, value }];
         return this;
     }
+    setConcurrencyGroup(concurrencyGroup) {
+        this.concurrencyGroup = concurrencyGroup;
+        return this;
+    }
     defaultRunner() {
         return "ubuntu-22.04";
     }
@@ -44,6 +47,12 @@ class Workflow {
         const result = {
             name: this.name,
             on: Object.fromEntries(this.events.map(({ name, options }) => [name, options ? options : null])),
+            concurrency: this.concurrencyGroup
+                ? {
+                    group: this.concurrencyGroup.groupSuffix,
+                    "cancel-in-progress": this.concurrencyGroup.cancelPrevious,
+                }
+                : undefined,
             defaults: this.defaultOptions
                 ? {
                     run: {
@@ -96,15 +105,6 @@ class Workflow {
             noRefs: true,
             lineWidth: 200,
             noCompatMode: true,
-            replacer: (_, value) => {
-                if (typeof value === "string") {
-                    if (value.startsWith("\n")) {
-                        return (0, lodash_1.compact)(value.split("\n").map((str) => (0, lodash_1.trim)(str))).join("\n");
-                    }
-                    return value;
-                }
-                return value;
-            },
         })}`;
         console.log(compiled);
         return compiled;

package/dist/workflow.spec.js

@@ -219,10 +219,25 @@ const workflow_1 = require("./workflow");
             steps: [
                 {
                     name: "Do something",
-                    run: `
-              echo foo
-              exit 0
-            `,
+                    run: `echo foo
+exit 0`,
+                },
+            ],
+        });
+        (0, vitest_1.expect)(workflow.compile()).toMatchSnapshot();
+    });
+    (0, vitest_1.it)("allows concurrency groups at workflow level", () => {
+        const workflow = new workflow_1.Workflow("Concurrency at workflow level")
+            .on("push")
+            .setConcurrencyGroup({
+            groupSuffix: "${{ github.workflow }}-${{ github.ref }}",
+            cancelPrevious: true,
+        })
+            .addJob("job1", {
+            steps: [
+                {
+                    name: "Do something",
+                    run: "exit 0",
                 },
             ],
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@factorialco/gat",
-  "version": "0.0.18",
+  "version": "0.0.20",
   "description": "TODO",
   "bin": {
     "gat": "dist/cli.js"