Skip to content

fix: validate README section configuration at input boundary (#670) #726

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

Merged
Jamie-BitFlight merged 2 commits into from
Oct 10, 2026
Merged

fix: validate README section configuration at input boundary (#670) #726

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4eeea2
fix: validate configured README sections before generation
Jamie-BitFlight Oct 10, 2026
df9882e
fix: retain unknown section tolerance while validating array shape
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
6 changes: 5 additions & 1 deletion src/inputs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -963,7 +963,11 @@ export default class Inputs {
'sections',
inputContext.sections ?? (this.config.get('sections') as ReadmeSection[]),
);
this.sections = this.config.get('sections') as ReadmeSection[];
const configuredSections: unknown = this.config.get('sections');
if (!Array.isArray(configuredSections) || !configuredSections.every((section: unknown) => typeof section === 'string')) {
Comment thread
Jamie-BitFlight marked this conversation as resolved.
throw new Error('Invalid sections configuration: expected an array of section names');
}
this.sections = configuredSections as ReadmeSection[];
this.readmePath =
inputContext.readmePath ?? path.resolve(this.config.get(ConfigKeys.pathsReadme) as string);
this.readmeEditor = inputContext.readmeEditor ?? new ReadmeEditor(this.readmePath);
Expand Down
Loading