https://github.com/xt0rted/actions-toolkit

Helper functions, scripts, and Typescript types for working with GitHub Actions
https://github.com/xt0rted/actions-toolkit

github-actions typescript

Last synced: 12 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/xt0rted/actions-toolkit
• Owner: xt0rted
• License: mit
• Created: 2022-02-15T03:33:11.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-07-14T15:24:35.000Z (12 months ago)
• Last Synced: 2025-07-14T18:43:26.986Z (12 months ago)
• Topics: github-actions, typescript
• Language: TypeScript
• Homepage:
• Size: 1.37 MB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# actions-toolkit

[![CI](https://github.com/xt0rted/actions-toolkit/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/xt0rted/actions-toolkit/actions/workflows/ci.yml)

[![CodeQL](https://github.com/xt0rted/actions-toolkit/actions/workflows/codeql-analysis.yml/badge.svg?branch=main)](https://github.com/xt0rted/actions-toolkit/actions/workflows/codeql-analysis.yml)

[![npm](https://img.shields.io/npm/v/@xt0rted/actions-toolkit)](https://www.npmjs.com/package/@xt0rted/actions-toolkit)

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:

- `...`

- `...`

- `...`

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.