action.ts

// https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions
export type ActionMetadata = {
  name: string;
  description: string;
  inputs?: ActionInputs;
  outputs?: ActionOutputs;
};

// https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputs
export type ActionInput = {
  description: string;
  required?: boolean;
  default?: string;
  deprecationMessage?: string;
};

export type ActionInputs = Record<string, ActionInput>;

// https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputs-for-docker-container-and-javascript-actions
export type ActionOutput = {
  description: string;
  value?: string;
};

export type ActionOutputs = Record<string, ActionOutput>;

export type ActionReference = {
  owner: string;
  name: string;
  ref: string;
  path?: string;
};

// https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsuses
export function parseActionReference(uses: string): ActionReference | undefined {
  if (!uses || uses.startsWith("docker://") || uses.startsWith("./") || uses.startsWith(".\\")) {
    return undefined;
  }

  const [action, ref] = uses.split("@");
  const [owner, name, ...pathSegments] = action.split(/[\\/]/).filter(s => s.length > 0);
  if (!owner || !name) {
    return undefined;
  }

  if (pathSegments.length === 0) {
    return {
      owner,
      name,
      ref
    };
  }

  return {
    owner,
    name,
    ref,
    path: pathSegments.join("/")
  };
}

export function actionIdentifier(ref: ActionReference): string {
  if (ref.path) {
    return `${ref.owner}/${ref.name}/${ref.ref}/${ref.path}`;
  }
  return `${ref.owner}/${ref.name}/${ref.ref}`;
}

export function actionUrl(actionRef: ActionReference, baseUri: string = "https://www.github.com/"): string {
  const gitHubBaseUri = baseUri.endsWith("/") ? baseUri : `${baseUri}/`;

  return `${gitHubBaseUri}${actionRef.owner}/${actionRef.name}/tree/${actionRef.ref}/${actionRef.path || ""}`;
}