A batteries-included template for scaffolding new GitHub Actions.
A starting point for ESM, bundled GitHub Actions — ships with action.yml, an
example handler, Jest (with manual @actions/* mocks), ESLint/Prettier,
semantic-release, Renovate, and issue/PR templates, plus a one-shot setup CLI
that wires it all to your action.
- Click Use this template on GitHub and create your repository.
yarn installyarn rename— an interactive CLI that collects the action name, description, owner, author, and your input/output variables, then rewritesaction.yml,package.json, the README, and everything else before removing itself (the entirescripts/directory).- Pass
--dry-runto preview every change without writing anything. - Supply
--name,--description,--owner, and/or--authorto skip the matching prompts.
- Pass
- Edit
main.jsto implement your action's logic. - Commit and push — semantic-release handles versioning and publishing.
- Replaces the
{{ ACTION_NAME }}/{{ ACTION_DESCRIPTION }}/{{ ACTION_AUTHOR }}/{{ ACTION_AUTHOR_EMAIL }}/{{ OWNER }}placeholders across the repository. - Generates the
action.ymlinputs/outputs and the README tables from the variables you define. - Installs the action-only
package.json,jest.config.js, andREADME.mdfromscripts/template/over the repository's own copies. - Detects sensible defaults: the owner from the git remote, and the author from
gh, the GitHub Actions context, or your commit email.
yarn format # eslint
yarn lint # eslint
yarn test # jest
yarn coverage # jest with the 80% coverage thresholdBuilt and maintained by Allons-y Studio — a US-based studio specializing in design systems, front-end architecture, and accessibility.