UNPKG

github-action-readme-generator

Version:

The docs generator for GitHub Actions. Auto-syncs action.yml to README.md with 8 sections: inputs, outputs, usage, badges, branding & more. Works as CLI or GitHub Action.

17 lines (16 loc) 689 B
/** * This TypeScript code imports necessary modules and defines a function named 'updateBadges' which takes a sectionToken (ReadmeSection) and an instance of the 'Inputs' class as its parameters. * The function is responsible for updating the badges section in the README.md file based on the provided inputs. * It utilizes the 'LogTask' class for logging purposes. */ import type { ReadmeSection } from '../constants.js'; import type Inputs from '../inputs.js'; /** * Interface for a badge. */ export interface IBadge { alt: string; img: string; url?: string; } export default function updateBadges(sectionToken: ReadmeSection, inputs: Inputs): Record<string, string>;