@intentius/chant-lexicon-github 0.0.18

package/src/composites/deploy-environment.ts

@@ -0,0 +1,77 @@
+import { Composite } from "@intentius/chant";
+
+export interface DeployEnvironmentProps {
+  /** Environment name. Required. */
+  name: string;
+  /** Deploy command(s). Required. */
+  deployScript: string | string[];
+  /** Cleanup command(s). Default: 'echo "Cleaning up..."' */
+  cleanupScript?: string | string[];
+  /** Environment URL */
+  url?: string;
+  /** Concurrency group. Default: "deploy-{name}" */
+  concurrencyGroup?: string;
+  /** Cancel in-progress deploys. Default: true */
+  cancelInProgress?: boolean;
+  /** Runner label. Default: "ubuntu-latest" */
+  runsOn?: string;
+}
+
+export const DeployEnvironment = Composite<DeployEnvironmentProps>((props) => {
+  const {
+    name,
+    deployScript,
+    cleanupScript = 'echo "Cleaning up..."',
+    url,
+    concurrencyGroup,
+    cancelInProgress = true,
+    runsOn = "ubuntu-latest",
+  } = props;
+
+  const group = concurrencyGroup ?? `deploy-${name}`;
+  const deployScriptArr = Array.isArray(deployScript) ? deployScript : [deployScript];
+  const cleanupScriptArr = Array.isArray(cleanupScript) ? cleanupScript : [cleanupScript];
+
+  const { createProperty, createResource } = require("@intentius/chant/runtime");
+  const StepClass = createProperty("GitHub::Actions::Step", "github");
+  const JobClass = createResource("GitHub::Actions::Job", "github", {});
+
+  // ── Deploy job ─────────────────────────────────────────────────────
+  const deploySteps = [
+    new StepClass({ name: "Checkout", uses: "actions/checkout@v4" }),
+    ...deployScriptArr.map(
+      (cmd: string) => new StepClass({ name: "Deploy", run: cmd }),
+    ),
+  ];
+
+  const environment: Record<string, string> = { name };
+  if (url) {
+    environment.url = url;
+  }
+
+  const deployJob = new JobClass({
+    "runs-on": runsOn,
+    environment,
+    concurrency: {
+      group,
+      "cancel-in-progress": cancelInProgress,
+    },
+    steps: deploySteps,
+  });
+
+  // ── Cleanup job ────────────────────────────────────────────────────
+  const cleanupSteps = [
+    new StepClass({ name: "Checkout", uses: "actions/checkout@v4" }),
+    ...cleanupScriptArr.map(
+      (cmd: string) => new StepClass({ name: "Cleanup", run: cmd }),
+    ),
+  ];
+
+  const cleanupJob = new JobClass({
+    "runs-on": runsOn,
+    environment: { name },
+    steps: cleanupSteps,
+  });
+
+  return { deployJob, cleanupJob };
+}, "DeployEnvironment");

package/src/composites/docker-build.ts

@@ -0,0 +1,120 @@
+import { Composite } from "@intentius/chant";
+
+export interface DockerBuildProps {
+  /** Image tag. Default: "${{ github.sha }}" */
+  tag?: string;
+  /** Dockerfile path. Default: "Dockerfile" */
+  dockerfile?: string;
+  /** Build context. Default: "." */
+  context?: string;
+  /** Container registry. Default: "ghcr.io" */
+  registry?: string;
+  /** Full image name. Default: "ghcr.io/${{ github.repository }}" */
+  imageName?: string;
+  /** Also tag as :latest. Default: true */
+  tagLatest?: boolean;
+  /** Extra docker build-args */
+  buildArgs?: Record<string, string>;
+  /** Push image after build. Default: true */
+  push?: boolean;
+  /** Multi-platform targets. e.g. ["linux/amd64", "linux/arm64"] */
+  platforms?: string[];
+  /** Runner label. Default: "ubuntu-latest" */
+  runsOn?: string;
+}
+
+export const DockerBuild = Composite<DockerBuildProps>((props) => {
+  const {
+    tag = "${{ github.sha }}",
+    dockerfile = "Dockerfile",
+    context = ".",
+    registry = "ghcr.io",
+    imageName = "ghcr.io/${{ github.repository }}",
+    tagLatest = true,
+    buildArgs,
+    push = true,
+    platforms,
+    runsOn = "ubuntu-latest",
+  } = props;
+
+  const { createProperty, createResource } = require("@intentius/chant/runtime");
+  const StepClass = createProperty("GitHub::Actions::Step", "github");
+  const JobClass = createResource("GitHub::Actions::Job", "github", {});
+  const WorkflowClass = createResource("GitHub::Actions::Workflow", "github", {});
+
+  // ── Steps ──────────────────────────────────────────────────────────
+  const checkout = new StepClass({ name: "Checkout", uses: "actions/checkout@v4" });
+
+  const login = new StepClass({
+    name: "Log in to container registry",
+    uses: "docker/login-action@v3",
+    with: {
+      registry,
+      username: "${{ github.actor }}",
+      password: "${{ secrets.GITHUB_TOKEN }}",
+    },
+  });
+
+  const setupBuildx = new StepClass({
+    name: "Set up Docker Buildx",
+    uses: "docker/setup-buildx-action@v3",
+  });
+
+  // Build tags for metadata action
+  const tags = [`${imageName}:${tag}`];
+  if (tagLatest) {
+    tags.push(`${imageName}:latest`);
+  }
+
+  const metadata = new StepClass({
+    name: "Extract metadata",
+    id: "meta",
+    uses: "docker/metadata-action@v5",
+    with: {
+      images: imageName,
+      tags: tags.join("\n"),
+    },
+  });
+
+  const buildPushWith: Record<string, string> = {
+    context,
+    file: dockerfile,
+    push: String(push),
+    tags: "${{ steps.meta.outputs.tags }}",
+    labels: "${{ steps.meta.outputs.labels }}",
+  };
+
+  if (platforms && platforms.length > 0) {
+    buildPushWith.platforms = platforms.join(",");
+  }
+
+  if (buildArgs) {
+    buildPushWith["build-args"] = Object.entries(buildArgs)
+      .map(([k, v]) => `${k}=${v}`)
+      .join("\n");
+  }
+
+  const buildPush = new StepClass({
+    name: "Build and push",
+    uses: "docker/build-push-action@v6",
+    with: buildPushWith,
+  });
+
+  const job = new JobClass({
+    "runs-on": runsOn,
+    steps: [checkout, login, setupBuildx, metadata, buildPush],
+  });
+
+  const workflow = new WorkflowClass({
+    name: "Docker Build",
+    on: {
+      push: { branches: ["main"] },
+    },
+    permissions: {
+      contents: "read",
+      packages: "write",
+    },
+  });
+
+  return { workflow, job };
+}, "DockerBuild");

package/src/composites/download-artifact.ts

@@ -0,0 +1,24 @@
+import { Composite } from "@intentius/chant";
+
+export interface DownloadArtifactProps {
+  name?: string;
+  path?: string;
+  mergeMultiple?: boolean;
+}
+
+export const DownloadArtifact = Composite<DownloadArtifactProps>((props) => {
+  const withObj: Record<string, string> = {};
+  if (props.name !== undefined) withObj.name = props.name;
+  if (props.path !== undefined) withObj.path = props.path;
+  if (props.mergeMultiple !== undefined) withObj["merge-multiple"] = String(props.mergeMultiple);
+
+  const { createProperty } = require("@intentius/chant/runtime");
+  const StepClass = createProperty("GitHub::Actions::Step", "github");
+  const step = new StepClass({
+    name: "Download Artifact",
+    uses: "actions/download-artifact@v4",
+    ...(Object.keys(withObj).length > 0 ? { with: withObj } : {}),
+  });
+
+  return { step };
+}, "DownloadArtifact");

package/src/composites/go-ci.ts

@@ -0,0 +1,91 @@
+import { Composite } from "@intentius/chant";
+
+export interface GoCIProps {
+  /** Go version. Default: "1.22" */
+  goVersion?: string;
+  /** Test command. Default: "go test ./... -v -race" */
+  testCommand?: string;
+  /** Build command. Default: "go build ./..." */
+  buildCommand?: string;
+  /** Lint command. Set to null to omit lint job. Default: "golangci-lint run" */
+  lintCommand?: string | null;
+  /** Runner label. Default: "ubuntu-latest" */
+  runsOn?: string;
+}
+
+export const GoCI = Composite<GoCIProps>((props) => {
+  const {
+    goVersion = "1.22",
+    testCommand = "go test ./... -v -race",
+    buildCommand = "go build ./...",
+    lintCommand = "golangci-lint run",
+    runsOn = "ubuntu-latest",
+  } = props;
+
+  const { createProperty, createResource } = require("@intentius/chant/runtime");
+  const StepClass = createProperty("GitHub::Actions::Step", "github");
+  const JobClass = createResource("GitHub::Actions::Job", "github", {});
+  const WorkflowClass = createResource("GitHub::Actions::Workflow", "github", {});
+
+  // ── Build job ──────────────────────────────────────────────────────
+  const buildJob = new JobClass({
+    "runs-on": runsOn,
+    steps: [
+      new StepClass({ name: "Checkout", uses: "actions/checkout@v4" }),
+      new StepClass({
+        name: "Setup Go",
+        uses: "actions/setup-go@v5",
+        with: { "go-version": goVersion },
+      }),
+      new StepClass({ name: "Build", run: buildCommand }),
+    ],
+  });
+
+  // ── Test job ───────────────────────────────────────────────────────
+  const testJob = new JobClass({
+    "runs-on": runsOn,
+    steps: [
+      new StepClass({ name: "Checkout", uses: "actions/checkout@v4" }),
+      new StepClass({
+        name: "Setup Go",
+        uses: "actions/setup-go@v5",
+        with: { "go-version": goVersion },
+      }),
+      new StepClass({ name: "Test", run: testCommand }),
+    ],
+  });
+
+  // ── Lint job (optional) ────────────────────────────────────────────
+  const lintJob =
+    lintCommand !== null
+      ? new JobClass({
+          "runs-on": runsOn,
+          steps: [
+            new StepClass({ name: "Checkout", uses: "actions/checkout@v4" }),
+            new StepClass({
+              name: "Setup Go",
+              uses: "actions/setup-go@v5",
+              with: { "go-version": goVersion },
+            }),
+            new StepClass({
+              name: "Lint",
+              uses: "golangci/golangci-lint-action@v6",
+              with: { args: lintCommand },
+            }),
+          ],
+        })
+      : undefined;
+
+  const workflow = new WorkflowClass({
+    name: "Go CI",
+    on: {
+      push: { branches: ["main"] },
+      pull_request: { branches: ["main"] },
+    },
+  });
+
+  if (lintJob) {
+    return { workflow, buildJob, testJob, lintJob };
+  }
+  return { workflow, buildJob, testJob } as any;
+}, "GoCI");

package/src/composites/index.ts

@@ -0,0 +1,26 @@
+export { Checkout } from "./checkout";
+export type { CheckoutProps } from "./checkout";
+export { SetupNode } from "./setup-node";
+export type { SetupNodeProps } from "./setup-node";
+export { SetupGo } from "./setup-go";
+export type { SetupGoProps } from "./setup-go";
+export { SetupPython } from "./setup-python";
+export type { SetupPythonProps } from "./setup-python";
+export { CacheAction } from "./cache";
+export type { CacheActionProps } from "./cache";
+export { UploadArtifact } from "./upload-artifact";
+export type { UploadArtifactProps } from "./upload-artifact";
+export { DownloadArtifact } from "./download-artifact";
+export type { DownloadArtifactProps } from "./download-artifact";
+export { NodeCI } from "./node-ci";
+export type { NodeCIProps } from "./node-ci";
+export { NodePipeline, BunPipeline, PnpmPipeline, YarnPipeline } from "./node-pipeline";
+export type { NodePipelineProps } from "./node-pipeline";
+export { PythonCI } from "./python-ci";
+export type { PythonCIProps } from "./python-ci";
+export { DockerBuild } from "./docker-build";
+export type { DockerBuildProps } from "./docker-build";
+export { DeployEnvironment } from "./deploy-environment";
+export type { DeployEnvironmentProps } from "./deploy-environment";
+export { GoCI } from "./go-ci";
+export type { GoCIProps } from "./go-ci";

package/src/composites/node-ci.ts

@@ -0,0 +1,71 @@
+import { Composite } from "@intentius/chant";
+
+export interface NodeCIProps {
+  nodeVersion?: string;
+  packageManager?: "npm" | "pnpm" | "yarn" | "bun";
+  buildScript?: string;
+  testScript?: string;
+  installCommand?: string;
+}
+
+export const NodeCI = Composite<NodeCIProps>((props) => {
+  const {
+    nodeVersion = "22",
+    packageManager = "npm",
+    buildScript = "build",
+    testScript = "test",
+    installCommand,
+  } = props;
+
+  const install = installCommand ?? (packageManager === "npm" ? "npm ci" : `${packageManager} install`);
+  const run = packageManager === "npm" ? "npm run" : packageManager;
+
+  const { createProperty, createResource } = require("@intentius/chant/runtime");
+  const StepClass = createProperty("GitHub::Actions::Step", "github");
+  const JobClass = createResource("GitHub::Actions::Job", "github", {});
+  const WorkflowClass = createResource("GitHub::Actions::Workflow", "github", {});
+
+  const checkoutStep = new StepClass({
+    name: "Checkout",
+    uses: "actions/checkout@v4",
+  });
+
+  const setupNodeStep = new StepClass({
+    name: "Setup Node.js",
+    uses: "actions/setup-node@v4",
+    with: {
+      "node-version": nodeVersion,
+      cache: packageManager === "bun" ? undefined : packageManager,
+    },
+  });
+
+  const installStep = new StepClass({
+    name: "Install dependencies",
+    run: install,
+  });
+
+  const buildStep = new StepClass({
+    name: "Build",
+    run: `${run} ${buildScript}`,
+  });
+
+  const testStep = new StepClass({
+    name: "Test",
+    run: `${run} ${testScript}`,
+  });
+
+  const job = new JobClass({
+    "runs-on": "ubuntu-latest",
+    steps: [checkoutStep, setupNodeStep, installStep, buildStep, testStep],
+  });
+
+  const workflow = new WorkflowClass({
+    name: "CI",
+    on: {
+      push: { branches: ["main"] },
+      pull_request: { branches: ["main"] },
+    },
+  });
+
+  return { workflow, job };
+}, "NodeCI");

package/src/composites/node-pipeline.ts

@@ -0,0 +1,151 @@
+import { Composite, withDefaults } from "@intentius/chant";
+
+export interface NodePipelineProps {
+  /** Node.js version. Default: "22" */
+  nodeVersion?: string;
+  /** Package manager. Default: "npm" */
+  packageManager?: "npm" | "pnpm" | "yarn" | "bun";
+  /** Build script name. Default: "build" */
+  buildScript?: string;
+  /** Test script name. Default: "test" */
+  testScript?: string;
+  /** Override auto-detected install command */
+  installCommand?: string;
+  /** Build artifact paths. Default: ["dist/"] */
+  buildArtifactPaths?: string[];
+  /** Artifact name. Default: "build-output" */
+  artifactName?: string;
+  /** Artifact retention days. Default: 1 */
+  artifactRetentionDays?: number;
+  /** Runner label. Default: "ubuntu-latest" */
+  runsOn?: string;
+}
+
+const cacheConfig = {
+  npm: {
+    cache: "npm",
+    installCmd: "npm ci",
+    runPrefix: "npm run",
+    setupAction: "actions/setup-node@v4",
+  },
+  pnpm: {
+    cache: "pnpm",
+    installCmd: "pnpm install --frozen-lockfile",
+    runPrefix: "pnpm run",
+    setupAction: "actions/setup-node@v4",
+  },
+  yarn: {
+    cache: "yarn",
+    installCmd: "yarn install --frozen-lockfile",
+    runPrefix: "yarn",
+    setupAction: "actions/setup-node@v4",
+  },
+  bun: {
+    cache: undefined,
+    installCmd: "bun install --frozen-lockfile",
+    runPrefix: "bun run",
+    setupAction: "oven-sh/setup-bun@v2",
+  },
+} as const;
+
+export const NodePipeline = Composite<NodePipelineProps>((props) => {
+  const {
+    nodeVersion = "22",
+    packageManager = "npm",
+    buildScript = "build",
+    testScript = "test",
+    installCommand,
+    buildArtifactPaths = ["dist/"],
+    artifactName = "build-output",
+    artifactRetentionDays = 1,
+    runsOn = "ubuntu-latest",
+  } = props;
+
+  const pm = cacheConfig[packageManager];
+  const install = installCommand ?? pm.installCmd;
+  const run = pm.runPrefix;
+
+  const { createProperty, createResource } = require("@intentius/chant/runtime");
+  const StepClass = createProperty("GitHub::Actions::Step", "github");
+  const JobClass = createResource("GitHub::Actions::Job", "github", {});
+  const WorkflowClass = createResource("GitHub::Actions::Workflow", "github", {});
+
+  const isBun = packageManager === "bun";
+
+  // ── Build job steps ────────────────────────────────────────────────
+  const buildCheckout = new StepClass({ name: "Checkout", uses: "actions/checkout@v4" });
+
+  const buildSetup = isBun
+    ? new StepClass({ name: "Setup Bun", uses: "oven-sh/setup-bun@v2" })
+    : new StepClass({
+        name: "Setup Node.js",
+        uses: "actions/setup-node@v4",
+        with: { "node-version": nodeVersion, cache: pm.cache },
+      });
+
+  const buildInstall = new StepClass({ name: "Install dependencies", run: install });
+
+  const buildRun = new StepClass({ name: "Build", run: `${run} ${buildScript}` });
+
+  const buildUpload = new StepClass({
+    name: "Upload build artifacts",
+    uses: "actions/upload-artifact@v4",
+    with: {
+      name: artifactName,
+      path: buildArtifactPaths.join("\n"),
+      "retention-days": String(artifactRetentionDays),
+    },
+  });
+
+  const buildJob = new JobClass({
+    "runs-on": runsOn,
+    steps: [buildCheckout, buildSetup, buildInstall, buildRun, buildUpload],
+  });
+
+  // ── Test job steps ─────────────────────────────────────────────────
+  const testCheckout = new StepClass({ name: "Checkout", uses: "actions/checkout@v4" });
+
+  const testSetup = isBun
+    ? new StepClass({ name: "Setup Bun", uses: "oven-sh/setup-bun@v2" })
+    : new StepClass({
+        name: "Setup Node.js",
+        uses: "actions/setup-node@v4",
+        with: { "node-version": nodeVersion, cache: pm.cache },
+      });
+
+  const testInstall = new StepClass({ name: "Install dependencies", run: install });
+
+  const testDownload = new StepClass({
+    name: "Download build artifacts",
+    uses: "actions/download-artifact@v4",
+    with: { name: artifactName },
+  });
+
+  const testRun = new StepClass({ name: "Test", run: `${run} ${testScript}` });
+
+  const testJob = new JobClass({
+    "runs-on": runsOn,
+    needs: ["build"],
+    steps: [testCheckout, testSetup, testInstall, testDownload, testRun],
+  });
+
+  // ── Workflow ───────────────────────────────────────────────────────
+  const workflow = new WorkflowClass({
+    name: "Node Pipeline",
+    on: {
+      push: { branches: ["main"] },
+      pull_request: { branches: ["main"] },
+    },
+  });
+
+  return { workflow, buildJob, testJob };
+}, "NodePipeline");
+
+/** NodePipeline preset for Bun projects. */
+export const BunPipeline = withDefaults(NodePipeline, { packageManager: "bun" as const });
+
+/** NodePipeline preset for pnpm projects. */
+export const PnpmPipeline = withDefaults(NodePipeline, { packageManager: "pnpm" as const });
+
+/** NodePipeline preset for Yarn projects. */
+export const YarnPipeline = withDefaults(NodePipeline, { packageManager: "yarn" as const });

package/src/composites/python-ci.ts

@@ -0,0 +1,92 @@
+import { Composite } from "@intentius/chant";
+
+export interface PythonCIProps {
+  /** Python version. Default: "3.12" */
+  pythonVersion?: string;
+  /** Test command. Default: "pytest --junitxml=report.xml --cov" */
+  testCommand?: string;
+  /** Lint command. Set to null to omit lint job. Default: "ruff check ." */
+  lintCommand?: string | null;
+  /** Requirements file. Default: "requirements.txt" */
+  requirementsFile?: string;
+  /** Use poetry instead of pip. Default: false */
+  usePoetry?: boolean;
+  /** Runner label. Default: "ubuntu-latest" */
+  runsOn?: string;
+}
+
+export const PythonCI = Composite<PythonCIProps>((props) => {
+  const {
+    pythonVersion = "3.12",
+    testCommand = "pytest --junitxml=report.xml --cov",
+    lintCommand = "ruff check .",
+    requirementsFile = "requirements.txt",
+    usePoetry = false,
+    runsOn = "ubuntu-latest",
+  } = props;
+
+  const { createProperty, createResource } = require("@intentius/chant/runtime");
+  const StepClass = createProperty("GitHub::Actions::Step", "github");
+  const JobClass = createResource("GitHub::Actions::Job", "github", {});
+  const WorkflowClass = createResource("GitHub::Actions::Workflow", "github", {});
+
+  const cacheType = usePoetry ? "poetry" : "pip";
+  const installSteps = usePoetry
+    ? [
+        new StepClass({ name: "Install Poetry", run: "pip install poetry" }),
+        new StepClass({ name: "Install dependencies", run: "poetry install" }),
+      ]
+    : [
+        new StepClass({ name: "Install dependencies", run: `pip install -r ${requirementsFile}` }),
+      ];
+
+  // ── Test job ───────────────────────────────────────────────────────
+  const testJob = new JobClass({
+    "runs-on": runsOn,
+    steps: [
+      new StepClass({ name: "Checkout", uses: "actions/checkout@v4" }),
+      new StepClass({
+        name: "Setup Python",
+        uses: "actions/setup-python@v5",
+        with: { "python-version": pythonVersion, cache: cacheType },
+      }),
+      ...installSteps,
+      new StepClass({ name: "Test", run: testCommand }),
+    ],
+  });
+
+  // ── Lint job (optional) ────────────────────────────────────────────
+  const lintJob =
+    lintCommand !== null
+      ? new JobClass({
+          "runs-on": runsOn,
+          steps: [
+            new StepClass({ name: "Checkout", uses: "actions/checkout@v4" }),
+            new StepClass({
+              name: "Setup Python",
+              uses: "actions/setup-python@v5",
+              with: { "python-version": pythonVersion, cache: cacheType },
+            }),
+            ...installSteps.map((s: any) => {
+              // Create fresh step instances for the lint job
+              return new StepClass({ name: s.props.name, run: s.props.run });
+            }),
+            new StepClass({ name: "Lint", run: lintCommand }),
+          ],
+        })
+      : undefined;
+
+  // ── Workflow ───────────────────────────────────────────────────────
+  const workflow = new WorkflowClass({
+    name: "Python CI",
+    on: {
+      push: { branches: ["main"] },
+      pull_request: { branches: ["main"] },
+    },
+  });
+
+  if (lintJob) {
+    return { workflow, testJob, lintJob };
+  }
+  return { workflow, testJob } as any;
+}, "PythonCI");

package/src/composites/setup-go.ts

@@ -0,0 +1,24 @@
+import { Composite } from "@intentius/chant";
+
+export interface SetupGoProps {
+  goVersion?: string;
+  goVersionFile?: string;
+  cache?: boolean;
+}
+
+export const SetupGo = Composite<SetupGoProps>((props) => {
+  const withObj: Record<string, string> = {};
+  if (props.goVersion !== undefined) withObj["go-version"] = props.goVersion;
+  if (props.goVersionFile !== undefined) withObj["go-version-file"] = props.goVersionFile;
+  if (props.cache !== undefined) withObj.cache = String(props.cache);
+
+  const { createProperty } = require("@intentius/chant/runtime");
+  const StepClass = createProperty("GitHub::Actions::Step", "github");
+  const step = new StepClass({
+    name: "Setup Go",
+    uses: "actions/setup-go@v5",
+    ...(Object.keys(withObj).length > 0 ? { with: withObj } : {}),
+  });
+
+  return { step };
+}, "SetupGo");