eric sciple
24 lines
882 B
TypeScript
24 lines
882 B
TypeScript
import {actionUrl, parseActionReference} from "@actions/languageservice/action";
|
|
import {isActionStep} from "@actions/workflow-parser/model/type-guards";
|
|
import {Step} from "@actions/workflow-parser/model/workflow-template";
|
|
import {Octokit} from "@octokit/rest";
|
|
import {fetchActionMetadata} from "../utils/action-metadata.js";
|
|
import {TTLCache} from "../utils/cache.js";
|
|
|
|
export async function getActionDescription(client: Octokit, cache: TTLCache, step: Step): Promise<string | undefined> {
|
|
if (!isActionStep(step)) {
|
|
return undefined;
|
|
}
|
|
const action = parseActionReference(step.uses.value);
|
|
if (!action) {
|
|
return undefined;
|
|
}
|
|
|
|
const metadata = await fetchActionMetadata(client, cache, action);
|
|
if (!metadata?.name || !metadata?.description) {
|
|
return undefined;
|
|
}
|
|
|
|
return `[**${metadata.name}**](${actionUrl(action)})\n\n${metadata.description}`;
|
|
}
|