This is an action to install Hatch in your GitHub Actions workflow.
You must use this action in one of your jobs' steps:
- name: Install Hatch
uses: step-security/pypa-hatch@v1| Name | Default | Description |
|---|---|---|
version |
latest |
The version of Hatch to install (e.g. 1.11.1). |
It's possible to use the install script outside of GitHub Actions assuming you set up your environment as follows:
- Set every option to an environment variable with uppercasing and replacing hyphens with underscores.
- Set the
RUNNER_TOOL_CACHEenvironment variable to the directory where you want to install Hatch. - Set the
GITHUB_PATHenvironment variable to a file that is writable which will contain the final directory where Hatch gets installed (usually$RUNNER_TOOL_CACHE/.hatch). - Set the
RUNNER_OSenvironment variable to the current platform using one of the following values:LinuxWindowsmacOS
- Set the
RUNNER_ARCHenvironment variable to the current architecture using one of the following values:X64ARM64
- Install pipx as a fallback installation method for when there is no standalone binary available. In this case, nothing will be written to
GITHUB_PATH.
