@github-actions-workflow-ts/lib 2.2.0 → 2.4.0-beta.1

package/dist/cjs/job/index.d.ts

@@ -1,5 +1,19 @@
 import type { GeneratedWorkflowTypes } from '../types/index.js';
 import type { Step } from '../step/index.js';
+/**
+ * Represents a standard GitHub Actions job that runs on a specified runner.
+ *
+ * A NormalJob contains steps that execute commands or actions on a runner.
+ * Jobs can depend on other jobs using the `needs` method.
+ *
+ * @example
+ * ```typescript
+ * const testJob = new NormalJob('test', {
+ *   'runs-on': 'ubuntu-latest',
+ * })
+ * testJob.addStep(new Step({ name: 'Checkout', uses: 'actions/checkout@v4' }))
+ * ```
+ */
 export declare class NormalJob {
     name: string;
     job: GeneratedWorkflowTypes.NormalJob;
@@ -10,6 +24,20 @@ export declare class NormalJob {
     needs(jobs: (NormalJob | ReusableWorkflowCallJob)[]): this;
     constructor(name: string, jobProps: GeneratedWorkflowTypes.NormalJob);
 }
+/**
+ * Represents a job that calls a reusable workflow.
+ *
+ * A ReusableWorkflowCallJob allows you to call another workflow file,
+ * either from the same repository or an external repository.
+ *
+ * @example
+ * ```typescript
+ * const deployJob = new ReusableWorkflowCallJob('deploy', {
+ *   uses: './.github/workflows/deploy.yml',
+ *   with: { environment: 'production' },
+ * })
+ * ```
+ */
 export declare class ReusableWorkflowCallJob {
     name: string;
     job: GeneratedWorkflowTypes.ReusableWorkflowCallJob;

package/dist/cjs/job/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/job/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAC/D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAA;AAE5C,qBAAa,SAAS;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,sBAAsB,CAAC,SAAS,CAAA;IACrC,KAAK,EAAE,sBAAsB,CAAC,IAAI,EAAE,CAAK;IAEhD,OAAO,CAAC,IAAI,EAAE,sBAAsB,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,IAAI;IAW5D,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI;IAQ7B,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAOzB,KAAK,CAAC,IAAI,EAAE,CAAC,SAAS,GAAG,uBAAuB,CAAC,EAAE,GAAG,IAAI;gBAc9C,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,sBAAsB,CAAC,SAAS;CAIrE;AAED,qBAAa,uBAAuB;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,sBAAsB,CAAC,uBAAuB,CAAA;IAE1D,KAAK,CAAC,IAAI,EAAE,CAAC,SAAS,GAAG,uBAAuB,CAAC,EAAE,GAAG,IAAI;gBAexD,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,sBAAsB,CAAC,uBAAuB;CAO3D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/job/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAC/D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAA;AAE5C;;;;;;;;;;;;;GAaG;AACH,qBAAa,SAAS;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,sBAAsB,CAAC,SAAS,CAAA;IACrC,KAAK,EAAE,sBAAsB,CAAC,IAAI,EAAE,CAAK;IAEhD,OAAO,CAAC,IAAI,EAAE,sBAAsB,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,IAAI;IAW5D,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI;IAQ7B,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAOzB,KAAK,CAAC,IAAI,EAAE,CAAC,SAAS,GAAG,uBAAuB,CAAC,EAAE,GAAG,IAAI;gBAc9C,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,sBAAsB,CAAC,SAAS;CAIrE;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,uBAAuB;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,sBAAsB,CAAC,uBAAuB,CAAA;IAE1D,KAAK,CAAC,IAAI,EAAE,CAAC,SAAS,GAAG,uBAAuB,CAAC,EAAE,GAAG,IAAI;gBAexD,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,sBAAsB,CAAC,uBAAuB;CAO3D"}

package/dist/cjs/job/index.js

@@ -1,6 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReusableWorkflowCallJob = exports.NormalJob = void 0;
+/**
+ * Represents a standard GitHub Actions job that runs on a specified runner.
+ *
+ * A NormalJob contains steps that execute commands or actions on a runner.
+ * Jobs can depend on other jobs using the `needs` method.
+ *
+ * @example
+ * ```typescript
+ * const testJob = new NormalJob('test', {
+ *   'runs-on': 'ubuntu-latest',
+ * })
+ * testJob.addStep(new Step({ name: 'Checkout', uses: 'actions/checkout@v4' }))
+ * ```
+ */
 class NormalJob {
     name;
     job;
@@ -45,6 +59,20 @@ class NormalJob {
     }
 }
 exports.NormalJob = NormalJob;
+/**
+ * Represents a job that calls a reusable workflow.
+ *
+ * A ReusableWorkflowCallJob allows you to call another workflow file,
+ * either from the same repository or an external repository.
+ *
+ * @example
+ * ```typescript
+ * const deployJob = new ReusableWorkflowCallJob('deploy', {
+ *   uses: './.github/workflows/deploy.yml',
+ *   with: { environment: 'production' },
+ * })
+ * ```
+ */
 class ReusableWorkflowCallJob {
     name;
     job;

package/dist/cjs/job/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/job/index.ts"],"names":[],"mappings":";;;AAGA,MAAa,SAAS;IACb,IAAI,CAAQ;IACZ,GAAG,CAAkC;IACrC,KAAK,GAAkC,EAAE,CAAA;IAEhD,OAAO,CAAC,IAA6C;QACnD,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,QAAQ;YAClD,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG;gBACb,GAAI,IAAI,CAAC,GAAG,CAAC,GAAkD;gBAC/D,GAAI,IAAmD;aACxD,CAAA;;YACE,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,IAAI,CAAA;QAExB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,QAAQ,CAAC,KAAa;QACpB,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM;YACxB,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;;YACnE,IAAI,CAAC,GAAG,CAAC,KAAmB,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEnE,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO,CAAC,IAAU;QAChB,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM;YAAE,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;;YACrE,IAAI,CAAC,GAAG,CAAC,KAAmB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEhD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,CAAC,IAA6C;QACjD,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM;YACxB,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG;gBACf,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK;gBACjB,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAmC,CAAC;aAC3B,CAAA;;YAEnC,IAAI,CAAC,GAAG,CAAC,KAAyC,GAAG,IAAI,CAAC,GAAG,CAC5D,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAmC,CACd,CAAA;QAEtC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,YAAY,IAAY,EAAE,QAA0C;QAClE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,GAAG,GAAG,QAAQ,CAAA;IACrB,CAAC;CACF;AAjDD,8BAiDC;AAED,MAAa,uBAAuB;IAC3B,IAAI,CAAQ;IACZ,GAAG,CAAgD;IAE1D,KAAK,CAAC,IAA6C;QACjD,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM;YACxB,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG;gBACf,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK;gBACjB,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAmC,CAAC;aAC3B,CAAA;;YAEnC,IAAI,CAAC,GAAG,CAAC,KAAyC,GAAG,IAAI,CAAC,GAAG,CAC5D,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAmC,CACd,CAAA;QAEtC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,YACE,IAAY,EACZ,QAAwD;QAExD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,GAAG,GAAG,QAAQ,CAAA;QAEnB,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AA3BD,0DA2BC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/job/index.ts"],"names":[],"mappings":";;;AAGA;;;;;;;;;;;;;GAaG;AACH,MAAa,SAAS;IACb,IAAI,CAAQ;IACZ,GAAG,CAAkC;IACrC,KAAK,GAAkC,EAAE,CAAA;IAEhD,OAAO,CAAC,IAA6C;QACnD,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,QAAQ;YAClD,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG;gBACb,GAAI,IAAI,CAAC,GAAG,CAAC,GAAkD;gBAC/D,GAAI,IAAmD;aACxD,CAAA;;YACE,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,IAAI,CAAA;QAExB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,QAAQ,CAAC,KAAa;QACpB,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM;YACxB,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;;YACnE,IAAI,CAAC,GAAG,CAAC,KAAmB,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEnE,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO,CAAC,IAAU;QAChB,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM;YAAE,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;;YACrE,IAAI,CAAC,GAAG,CAAC,KAAmB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEhD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,CAAC,IAA6C;QACjD,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM;YACxB,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG;gBACf,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK;gBACjB,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAmC,CAAC;aAC3B,CAAA;;YAEnC,IAAI,CAAC,GAAG,CAAC,KAAyC,GAAG,IAAI,CAAC,GAAG,CAC5D,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAmC,CACd,CAAA;QAEtC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,YAAY,IAAY,EAAE,QAA0C;QAClE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,GAAG,GAAG,QAAQ,CAAA;IACrB,CAAC;CACF;AAjDD,8BAiDC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAa,uBAAuB;IAC3B,IAAI,CAAQ;IACZ,GAAG,CAAgD;IAE1D,KAAK,CAAC,IAA6C;QACjD,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM;YACxB,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG;gBACf,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK;gBACjB,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAmC,CAAC;aAC3B,CAAA;;YAEnC,IAAI,CAAC,GAAG,CAAC,KAAyC,GAAG,IAAI,CAAC,GAAG,CAC5D,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAmC,CACd,CAAA;QAEtC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,YACE,IAAY,EACZ,QAAwD;QAExD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,GAAG,GAAG,QAAQ,CAAA;QAEnB,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AA3BD,0DA2BC"}

package/dist/cjs/step/index.d.ts

@@ -1,4 +1,19 @@
 import type { GeneratedWorkflowTypes } from '../types/index.js';
+/**
+ * Represents a single step within a GitHub Actions job.
+ *
+ * A Step can either run a shell command (`run`) or use a GitHub Action (`uses`).
+ * Steps execute sequentially within a job.
+ *
+ * @example
+ * ```typescript
+ * // Run a shell command
+ * const testStep = new Step({ name: 'Run tests', run: 'npm test' })
+ *
+ * // Use a GitHub Action
+ * const checkoutStep = new Step({ name: 'Checkout', uses: 'actions/checkout@v4' })
+ * ```
+ */
 export declare class Step {
     step: GeneratedWorkflowTypes.Step;
     id: string | undefined;

package/dist/cjs/step/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/step/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAE/D,qBAAa,IAAI;IACR,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAA;IACjC,EAAE,EAAE,MAAM,GAAG,SAAS,CAAA;IAE7B,OAAO,CAAC,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI;gBAa3C,SAAS,EAAE,sBAAsB,CAAC,IAAI;CAMnD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/step/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAE/D;;;;;;;;;;;;;;GAcG;AACH,qBAAa,IAAI;IACR,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAA;IACjC,EAAE,EAAE,MAAM,GAAG,SAAS,CAAA;IAE7B,OAAO,CAAC,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI;gBAa3C,SAAS,EAAE,sBAAsB,CAAC,IAAI;CAMnD"}

package/dist/cjs/step/index.js

@@ -1,6 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Step = void 0;
+/**
+ * Represents a single step within a GitHub Actions job.
+ *
+ * A Step can either run a shell command (`run`) or use a GitHub Action (`uses`).
+ * Steps execute sequentially within a job.
+ *
+ * @example
+ * ```typescript
+ * // Run a shell command
+ * const testStep = new Step({ name: 'Run tests', run: 'npm test' })
+ *
+ * // Use a GitHub Action
+ * const checkoutStep = new Step({ name: 'Checkout', uses: 'actions/checkout@v4' })
+ * ```
+ */
 class Step {
     step;
     id;

package/dist/cjs/step/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/step/index.ts"],"names":[],"mappings":";;;AAEA,MAAa,IAAI;IACR,IAAI,CAA6B;IACjC,EAAE,CAAoB;IAE7B,OAAO,CAAC,IAAwC;QAC9C,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,QAAQ;YACpD,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG;gBACd,GAAI,IAAI,CAAC,IAAI,CAAC,GAEZ;gBACF,GAAI,IAAmD;aACxD,CAAA;;YACE,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAA;QAEzB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,YAAY,SAAsC;QAChD,IAAI,CAAC,IAAI,GAAG;YACV,GAAG,SAAS;SACb,CAAA;QACD,IAAI,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,CAAA;IACxB,CAAC;CACF;AAvBD,oBAuBC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/step/index.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;GAcG;AACH,MAAa,IAAI;IACR,IAAI,CAA6B;IACjC,EAAE,CAAoB;IAE7B,OAAO,CAAC,IAAwC;QAC9C,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,QAAQ;YACpD,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG;gBACd,GAAI,IAAI,CAAC,IAAI,CAAC,GAEZ;gBACF,GAAI,IAAmD;aACxD,CAAA;;YACE,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAA;QAEzB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,YAAY,SAAsC;QAChD,IAAI,CAAC,IAAI,GAAG;YACV,GAAG,SAAS;SACb,CAAA;QACD,IAAI,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,CAAA;IACxB,CAAC;CACF;AAvBD,oBAuBC"}