This repository hosts shared workflows for GitHub Actions and shared actions that are used by repositories of the ComPWA Project. See also ComPWA/repo-maintenance, which enforces policies on those repositories.
Actions and shared workflows provided by this repository presume that the repository to which they are applied follow the same set-up as described on compwa.github.io/develop. For example, it assumes source code is located under the src/ directory and documentation is located under docs/.
See CONTRIBUTING.md for how to develop this repository.
The shared style workflow uses a configured poe style or pixi run style task, and otherwise runs prek run --all-files. The run-style action inspects Poe tasks in pyproject.toml and Pixi tasks in pixi.toml or pyproject.toml. Direct prek run command tasks without argument templates receive selected hook IDs together and skip installation of pre-commit and pre-commit-uv. Recognized options are --all-files (-a), --show-diff-on-failure, and --verbose (-v). Tasks using pre-commit, wrappers, other options, or Pixi task overrides retain one invocation per hook and install both compatibility packages. The configured task runner still executes the task with its own environment.
The run-style action requires checkout, uv, and prek to be set up first. Its optional hooks input accepts space-separated hook IDs and defaults to ALL, which runs the complete style task. Its optional python-version input defaults to 3.13 and selects the Python version used to install task runners.