Contributing

Working on the action itself.

Building and testing the action, previewing the documentation website, and where to report issues or ask questions.

Contributions are welcome. Open an issue or a pull request on the GitHub repository, and use Discussions for questions.

Development

npm install     # Install dependencies
npm run build   # Build the action
npm test        # Run tests
npm run format  # Format code
npm run lint    # Lint code
npm run all     # Format, lint, and build

The action runs from dist/index.js, which is built from src/ with ncc and committed to the repository, so npm run build must be run before opening a pull request that touches src/.

Documentation

This website lives in docs/ and is a Quarto project using the atelier project type.

quarto preview docs   # Preview locally
quarto render docs    # Render to docs/_site

The inputs and outputs tables are generated from action.yml by docs/assets/filters/action-reference.lua, so adding an input to the action is enough for it to appear in the documentation.

Back to top