Skip to content

fix: validate nested action inputs, outputs and branding (#670) #727

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Jamie-BitFlight wants to merge 3 commits into from
Closed

fix: validate nested action inputs, outputs and branding (#670) #727

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4dec063
fix: guard malformed runs metadata and preserve load error causes
Jamie-BitFlight Oct 10, 2026
2dd9b34
fix: validate nested metadata consumed by README generation
Jamie-BitFlight Oct 10, 2026
2f55352
fix: validate consumed descriptions without restricting scalar defaults
Jamie-BitFlight Oct 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions src/Action.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,14 +123,26 @@ export type ActionYaml = {
* Parses and represents metadata from action.yml.
*/
export default class Action implements ActionYaml {
static validate(obj: unknown): obj is ActionType {
static validate(obj: unknown): obj is ActionYaml {
if (typeof obj !== 'object' || obj === null) {
return false;
}
const record = obj as Record<string, unknown>;
const isRecord = (value: unknown): value is Record<string, unknown> =>
typeof value === 'object' && value !== null && !Array.isArray(value);
const validDescriptions = (value: unknown): boolean =>
value === undefined ||
(isRecord(value) &&
Object.values(value).every(
(entry) => isRecord(entry) &&
(entry.description === undefined || typeof entry.description === 'string'),
));
if (!validDescriptions(record.inputs) || !validDescriptions(record.outputs)) {
return false;
}
if ('name' in record && 'description' in record && 'runs' in record) {
const runs = record.runs as Record<string, unknown> | undefined;
if (runs && 'using' in runs) {
const runs = record.runs;
if (typeof runs === 'object' && runs !== null && !Array.isArray(runs) && 'using' in runs) {
return (
typeof record.name === 'string' &&
typeof record.description === 'string' &&
Expand Down Expand Up @@ -183,7 +195,7 @@ export default class Action implements ActionYaml {
try {
actionYaml = this.loadActionFrom(actionPath);
} catch (error) {
throw new Error(`Failed to load ${actionPath}. ${String(error)}`);
throw new Error(`Failed to load ${actionPath}. ${String(error)}`, { cause: error });
}
this.log.debug(`Action YAML: ${JSON.stringify(actionYaml)}`);

Expand Down Expand Up @@ -215,7 +227,7 @@ export default class Action implements ActionYaml {
this.rawYamlString = fs.readFileSync(actionPath, 'utf8');

this.log.debug(`Parse ${actionPath} from ${actionDir}`);
const actionObj = YAML.parse(this.rawYamlString) as ActionYaml;
const actionObj: unknown = YAML.parse(this.rawYamlString);
if (Action.validate(actionObj)) {
return actionObj;
}
Expand Down
Loading