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
12 lines (11 loc) • 806 B
TypeScript
/**
* This TypeScript code exports a function named 'updateSection' which takes a section (ReadmeSection) and an instance of the 'Inputs' class as its parameters.
* The function is responsible for updating different sections of the README.md file based on the provided section input.
* It utilizes various update functions (e.g., updateBranding, updateBadges) to update specific sections.
* @param {ReadmeSection} section - The section of the README to update.
* @param {Inputs} inputs - The Inputs class instance.
* @returns {Promise<void>} A promise that resolves once the section is updated.
*/
import { ReadmeSection } from '../constants.js';
import type Inputs from '../inputs.js';
export default function updateSection(section: ReadmeSection, inputs: Inputs): Promise<Record<string, string>>;