@octotask/adapter-github-actions/index.js

Adapter to run a Octotask application function in GitHub Actions

export * from "octotask";
import { createOctotask } from "octotask";
import pino from "pino";
import { readFileSync } from "node:fs";

import { transport } from "./pino-transport-github-actions.js";

export async function run(app) {
  const log = pino({}, transport);

  const githubToken =
    process.env.GITHUB_TOKEN ||
    process.env.INPUT_GITHUB_TOKEN ||
    process.env.INPUT_TOKEN;

  if (!githubToken) {
    log.error(
      "[octotask/adapter-github-actions] a token must be passed as `env.GITHUB_TOKEN` or `with.GITHUB_TOKEN` or `with.token`, see https://github.com/octotask/adapter-github-actions#usage"
    );
    return;
  }

  const envVariablesMissing = [
    "GITHUB_RUN_ID",
    "GITHUB_EVENT_NAME",
    "GITHUB_EVENT_PATH",
  ].filter((name) => !process.env[name]);

  if (envVariablesMissing.length) {
    log.error(
      `[octotask/adapter-github-actions] GitHub Action default environment variables missing: ${envVariablesMissing.join(
        ", "
      )}. See https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables#default-environment-variables`
    );
    return;
  }

  const octotask = createOctotask({
    overrides: {
      githubToken,
      log,
    },
  });

  await octotask.load(app);

  return octotask
    .receive({
      id: process.env.GITHUB_RUN_ID,
      name: process.env.GITHUB_EVENT_NAME,
      payload: JSON.parse(readFileSync(process.env.GITHUB_EVENT_PATH)),
    })
    .catch((error) => {
      octotask.log.error(error);
    });
}