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
11 lines (10 loc) • 718 B
TypeScript
/**
* This TypeScript code exports a function named 'updateDescription' which takes a sectionToken (ReadmeSection) and an instance of the 'Inputs' class as its parameters.
* The function is responsible for updating the description section in the README.md file based on the provided inputs.
* It utilizes the 'LogTask' class for logging purposes.
* @param {ReadmeSection} sectionToken - The sectionToken representing the section of the README to update.
* @param {Inputs} inputs - The Inputs class instance.
*/
import { ReadmeSection } from '../constants.js';
import type Inputs from '../inputs.js';
export default function updateDescription(sectionToken: ReadmeSection, inputs: Inputs): Record<string, string>;