Contributing

Building the Action

Before committing changes that affect the action code, you must rebuild the dist folder:

npm run build

This compiles all dependencies into dist/index.js which is what GitHub Actions actually runs.

Important: The dist folder must be committed to the repository for the action to work.

If you forget to rebuild dist, the update-dist workflow will automatically update it for you on pull requests.

This project requires Node.js v20. We recommend using nvm to manage Node versions:

nvm use
npm ci
npm run build

Run tests with:

npm test

This project uses pre-commit hooks to ensure code quality. Install them with:

pre-commit install