1.0.0 • Published 10 months ago

@xt0rted/actions-toolkit v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

actions-toolkit

CI CodeQL npm

Helper functions, scripts, and Typescript types for working with GitHub Actions.

Scripts

NameOptionsDescription
update-readme--include-exampleUpdates the README.md with tables for inputs, outputs, and optionally a minimal example.

update-readme

This will read the inputs and outputs from the action.yml and build documentation tables from them. Then placeholders in your README.md will be replaced with them

The placeholders are:

  • <!-- start example -->...<!-- end example -->
  • <!-- start inputs -->...<!-- end inputs -->
  • <!-- start outputs -->...<!-- end outputs -->

By default the example isn't built or replaced, you need to pass --include-example to include it.

Types

NameDescription
action-ymlTypes for the action.yml file.