mirror of https://github.com/imjasonh/apidiff-action synced 2026-07-06 22:52:43 +00:00

fix: remove check-dist workflow and add contributing guide

- The check-dist workflow has OS-specific build differences
- Add CONTRIBUTING.md to document the build process
- Developers must manually run 'npm run build' before committing

2025-07-30 10:01:03 -04:00

671 B

Raw Blame History

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.

Node Version

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

nvm use
npm ci
npm run build

Testing

Run tests with:

npm test

Pre-commit Hooks

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

pre-commit install