A minimal template for building a JavaScript GitHub Action in TypeScript with Node.js. Ships pre-configured with formatting, linting, 100% test coverage enforcement, pre-commit hooks, and CI.
Create a new repository from this template on GitHub using this link, or clone it locally and point it at your own remote.
Install pnpm, then install dependencies:
pnpm installInstall Lefthook, then register the pre-commit hook:
lefthook installReplace or extend the template files to fit your project:
.github/workflows/ci.yaml— Update or replace thetestjob with jobs that test your action as needed.src/download.ts— Replace the placeholder file-download function with your own.src/main.ts— Replace with your own action logic.action.yml— Update the action's name, description, branding, and inputs/outputs to match what your action does.CLAUDE.md— Replace with guidance specific to your project.LICENSE— Replace with your preferred license, or keep the Unlicense.README.md— Replace with a description of your project.
Write code in src/, using ghakit for GitHub Actions utilities such as inputs, outputs, and logging. Test files live alongside source as *.test.ts. Run the test suite with:
pnpm vitest runThe project enforces 100% code coverage on every run.
Each git commit runs the pre-commit hook registered during setup, which checks your changes and fixes what it can in place. If it fails, fix any reported issues, re-stage the changed files, and commit again.
After committing, push to main or open a pull request from another branch — CI will run the same checks across all files, plus additional checks of its own.
Push a version tag and create a GitHub Release. To publish the action to GitHub Marketplace, check the option when creating the release — see Publishing actions in GitHub Marketplace for guidance.