Skip to content

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

License

Notifications You must be signed in to change notification settings

xt0rted/actions-toolkit

Repository files navigation

actions-toolkit

CI CodeQL npm

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

Scripts

Name Options Description
update-readme --include-example Updates 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

Name Description
action-yml Types for the action.yml file.

About

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

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Contributors 4

  •  
  •  
  •  
  •