github-action-readme-generator
Version:
This is a CLI tool and GitHub Action that reads in the details from a GitHub Action's `action.yml` file and updates the `README.md` file with the `name`, `description`, `usage`, `inputs`, `outputs`, and examples of the action. Configuration can be provid
17 lines (16 loc) • 684 B
TypeScript
/**
* 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 { 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>;