[![release](https://img.shields.io/github/release/snok/install-poetry.svg)](https://github.com/snok/install-poetry/releases/latest)
[![tests](https://github.com/snok/install-poetry/actions/workflows/test.yml/badge.svg)](https://github.com/snok/install-poetry/actions/workflows/test.yml)

# Install Poetry Action

A Github action for installing and configuring [Poetry](https://python-poetry.org/).

The action installs Poetry, adds executables to the runner system path, and sets relevant Poetry config settings.

## Usage

If all you need is default Poetry, simply add this to your workflow:

```yaml
- name: Install Poetry
  uses: snok/install-poetry@v1
```

If you want to set Poetry config settings, or install a specific version, you can specify inputs:

```yaml
- name: Install and configure Poetry
  uses: snok/install-poetry@v1
  with:
    version: 2.4.1
    virtualenvs-create: true
    virtualenvs-in-project: false
    virtualenvs-path: ~/my-custom-path
    installer-parallel: true
```

If you need to pass extra arguments to the installer script, you can specify these with `installation-arguments`.

The action is fully tested for macOS and Ubuntu runners, on Poetry versions >= 1.8. If you're using this with Windows, see the [Running on Windows](#running-on-windows) section.

## Defaults

The current default settings are:

```yaml
version: latest
virtualenvs-create: true
virtualenvs-in-project: false
virtualenvs-path: {cache-dir}/virtualenvs
installer-parallel: true
```

You can specify installation arguments directly to the poetry installer using the installation-arguments in the following
way:

```yaml
- name: Install and configure Poetry
  uses: snok/install-poetry@v1
  with:
    installation-arguments: --git https://github.com/python-poetry/poetry.git@19a2f7bddb9bdf931a229ea0913a84021f3f9b93
```

If you want to make further config changes - e.g., to change one of the `experimental` Poetry config settings, or just
to make changes to the Poetry config *after* invoking the action - you can do so in a subsequent step, like this:

```yaml
- uses: snok/install-poetry@v1
- run: poetry config virtualenvs.prefer-active-python true
```

## Workflow examples and tips

This section contains a collection of workflow examples to try and help

- Give you a starting point for setting up your own workflows
- Demonstrate how to implement caching for performance improvements
- Clarify the implications of different settings

Some examples are a bit long, so here are some links

- [Install Poetry Action](#install-poetry-action)
  - [Usage](#usage)
  - [Defaults](#defaults)
  - [Workflow examples and tips](#workflow-examples-and-tips)
      - [Testing](#testing)
      - [Testing using a matrix](#testing-using-a-matrix)
      - [Codecov upload](#codecov-upload)
      - [Running on Windows](#running-on-windows)
        - [Caching on Windows runners](#caching-on-windows-runners)
      - [Virtualenv variations](#virtualenv-variations)
      - [Caching the Poetry installation](#caching-the-poetry-installation)
      - [Installing Poetry Plugins](#installing-poetry-plugins)
  - [Contributing](#contributing)
  - [License](#license)
  - [Showing your support](#showing-your-support)

#### Testing

A basic example workflow for running your test-suite can be structured like this.

```yaml
name: test

on: pull_request

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      #----------------------------------------------
      #       check-out repo and set-up python
      #----------------------------------------------
      - name: Check out repository
        uses: actions/checkout@v6
      - name: Set up python
        id: setup-python
        uses: actions/setup-python@v6
        with:
          python-version: '3.14'
      #----------------------------------------------
      #  -----  install & configure poetry  -----
      #----------------------------------------------
      - name: Install Poetry
        uses: snok/install-poetry@v1
        with:
          virtualenvs-create: true
          virtualenvs-in-project: true
          virtualenvs-path: .venv
          installer-parallel: true

      #----------------------------------------------
      #       load cached venv if cache exists
      #----------------------------------------------
      - name: Load cached venv
        id: cached-poetry-dependencies
        uses: actions/cache@v5
        with:
          path: .venv
          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
      #----------------------------------------------
      # install dependencies if cache does not exist
      #----------------------------------------------
      - name: Install dependencies
        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
        run: poetry install --no-interaction --no-root
      #----------------------------------------------
      # install your root project, if required
      #----------------------------------------------
      - name: Install project
        run: poetry install --no-interaction
      #----------------------------------------------
      #              run test suite
      #----------------------------------------------
      - name: Run tests
        run: |
          source .venv/bin/activate
          pytest tests/
          coverage report
```

#### Testing using a matrix

A more extensive example for running your test-suite on combinations of multiple operating systems, python versions, or
package-versions, can be structured like this.

*The linting job has nothing to do with the matrix, and is only included for inspiration.*

```yaml
name: test

on: pull_request

jobs:
  linting:
    runs-on: ubuntu-latest
    steps:
      #----------------------------------------------
      #       check-out repo and set-up python
      #----------------------------------------------
      - uses: actions/checkout@v6
      - uses: actions/setup-python@v6
      #----------------------------------------------
      #        load pip cache if cache exists
      #----------------------------------------------
      - uses: actions/cache@v5
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip
          restore-keys: ${{ runner.os }}-pip
      #----------------------------------------------
      #          install and run linters
      #----------------------------------------------
      - run: python -m pip install black flake8 isort
      - run: |
          flake8 .
          black . --check
          isort .
  test:
    needs: linting
    strategy:
      fail-fast: true
      matrix:
        os: [ "ubuntu-latest", "macos-latest" ]
        python-version: [ "3.10", "3.11", "3.12", "3.13", "3.14" ]
        django-version: [ "4", "5" ]
    runs-on: ${{ matrix.os }}
    steps:
      #----------------------------------------------
      #       check-out repo and set-up python
      #----------------------------------------------
      - name: Check out repository
        uses: actions/checkout@v6
      - name: Set up python ${{ matrix.python-version }}
        id: setup-python
        uses: actions/setup-python@v6
        with:
          python-version: ${{ matrix.python-version }}
      #----------------------------------------------
      #  -----  install & configure poetry  -----
      #----------------------------------------------
      - name: Install Poetry
        uses: snok/install-poetry@v1
        with:
          virtualenvs-create: true
          virtualenvs-in-project: true
      #----------------------------------------------
      #       load cached venv if cache exists
      #----------------------------------------------
      - name: Load cached venv
        id: cached-poetry-dependencies
        uses: actions/cache@v5
        with:
          path: .venv
          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
      #----------------------------------------------
      # install dependencies if cache does not exist
      #----------------------------------------------
      - name: Install dependencies
        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
        run: poetry install --no-interaction --no-root
      #----------------------------------------------
      # install your root project, if required
      #----------------------------------------------
      - name: Install library
        run: poetry install --no-interaction
      #----------------------------------------------
      #    add matrix specifics and run test suite
      #----------------------------------------------
      - name: Install django ${{ matrix.django-version }}
        run: |
          source .venv/bin/activate
          pip install "Django==${{ matrix.django-version }}"
      - name: Run tests
        run: |
          source .venv/bin/activate
          pytest tests/
          coverage report
```

#### Codecov upload

This section contains a simple codecov upload. See the
[codecov action](https://github.com/codecov/codecov-action) for more information.

```yaml
name: coverage

on:
  push:
    branches:
      - master

jobs:
  codecov:
    runs-on: ubuntu-latest
    steps:
      #----------------------------------------------
      #       check-out repo and set-up python
      #----------------------------------------------
      - uses: actions/checkout@v6
      - uses: actions/setup-python@v6
        id: setup-python
        with:
          python-version: '3.14'
      #----------------------------------------------
      #  -----  install & configure poetry  -----
      #----------------------------------------------
      - name: Install Poetry
        uses: snok/install-poetry@v1
        with:
          virtualenvs-create: true
          virtualenvs-in-project: true
      #----------------------------------------------
      #       load cached venv if cache exists
      #----------------------------------------------
      - name: Load cached venv
        id: cached-poetry-dependencies
        uses: actions/cache@v5
        with:
          path: .venv
          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
      #----------------------------------------------
      # install dependencies if cache does not exist
      #----------------------------------------------
      - name: Install dependencies
        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
        run: poetry install --no-interaction --no-root
      #----------------------------------------------
      # install your root project, if required
      #----------------------------------------------
      - name: Install library
        run: poetry install --no-interaction
      #----------------------------------------------
      #    run test suite and output coverage file
      #----------------------------------------------
      - name: Test with pytest
        run: poetry run pytest --cov=<project-dir> --cov-report=xml
      #----------------------------------------------
      #             upload coverage stats
      # (requires CODECOV_TOKEN in repository secrets)
      #----------------------------------------------
      - name: Upload coverage
        uses: codecov/codecov-action@v5
        with:
          token: ${{ secrets.CODECOV_TOKEN }}  # Only required for private repositories
          file: ./coverage.xml
          fail_ci_if_error: true
```

#### Running on Windows

Running this action on Windows is supported, but two things are important to note:

1. You need to set the job-level default shell to `bash`

    ```yaml
    defaults:
      run:
        shell: bash
    ```
2. If you are running an OS matrix, and want to activate your venv `in-project`
   you have to deal with different folder structures on different operating systems. To make this work, you *can* do
   this

   ```yaml
   - run: |
       source .venv/scripts/activate
       pytest --version
     if: runner.os == 'Windows'
   - run: |
       source .venv/bin/activate
       pytest --version
     if: runner.os != 'Windows'
   ```

   but we think this is an annoying way to have to structure our workflows, so we set a custom environment
   variable, `$VENV` which will point to the OS-specific venv activation script, whether you're running UNIX or Windows.
   This means you can do this instead

   ```yaml
   - run: |
       source $VENV
       pytest --version
   ```

For context, a full os-matrix using `windows-latest` could be set up like this:

```yaml
name: test

on: pull_request

jobs:
  test-windows:
    strategy:
      matrix: [ "ubuntu-latest", "macos-latest", "windows-latest" ]
    defaults:
      run:
        shell: bash
    runs-on: ${{ matrix.os }}
    steps:
      - name: Check out repository
        uses: actions/checkout@v6
      - name: Set up python
        id: setup-python
        uses: actions/setup-python@v6
        with:
          python-version: '3.14'
      - name: Install Poetry
        uses: snok/install-poetry@v1
        with:
          virtualenvs-create: true
          virtualenvs-in-project: true
      - name: Load cached venv
        id: cached-pip-wheels
        uses: actions/cache@v5
        with:
          path: ~/.cache
          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
      - name: Install dependencies
        run: poetry install --no-interaction --no-root
      - name: Install library
        run: poetry install --no-interaction
      - run: |
          source $VENV
          pytest --version
```

##### Caching on Windows runners

For some reason, caching your `venv` does not seem to work as expected on Windows runners. You can see an example of
what happens [here](https://github.com/snok/install-poetry/actions/runs/507576956), where a workflow stalls and runs for
over 3 hours before it was manually cancelled.

If you do want to cache your dependencies on a Windows runner, you should look into caching your pip wheels instead of
your venv; this seems to work fine.

#### Virtualenv variations

All of the examples we've added use these Poetry settings

```yaml
- name: Install Poetry
  uses: snok/install-poetry@v1
  with:
    virtualenvs-create: true
    virtualenvs-in-project: true
```

While this should work for most, and we generally prefer creating our
`virtualenvs` in-project to make the caching step as simple as possible, there are valid reasons for not wanting to
construct a venv in your project directory.

There are two other relevant scenarios:

1. Creating a venv, but not in the project dir

   If you're using the default settings, the venv location changes from `.venv` to using `{cache-dir}/virtualenvs`. You
   can also change the path to whatever you'd like. Generally though, this can make things a little tricky, because the
   directory will be vary depending on the OS, making it harder to write OS-agnostic workflows.

   A solution to this is to bypass this issue completely by taking advantage of Poetry's `poetry run` command.

   Using the last two steps in the [Matrix testing](#mtesting) example as an example, this is how we have otherwise
   documented installing a matrix-specific dependency and running the test suite:

    ```yaml
    - name: Install django ${{ matrix.django-version }}
      run: |
        source .venv/bin/activate
        pip install "Django==${{ matrix.django-version }}"
    - name: Run tests
      run: |
        source .venv/bin/activate
        pytest tests/
        coverage report
    ```

   With a remote venv you can do this instead:

    ```yaml
    - name: Install django ${{ matrix.django-version }}
      run: poetry add "Django==${{ matrix.django-version }}"
    - name: Run tests
      run: |
        poetry run pytest tests/
        poetry run coverage report
    ```

   > We have never needed to cache remote venvs in our workflows.
   > If you have, feel free to submit a PR explaining how it's done.

2. Skipping venv creation

   If you want to skip venv creation, all the original examples are made valid by simply removing the venv activation
   line: `source .venv/bin/activate`.

   To enable caching in this case, you will want to set up something resembling the linting job caching step in
   the [Matrix testing](#mtesting); caching your pip wheels rather than your installed dependencies.

   Since you're not caching your whole venv, you will need to re-install dependencies every time you run the job;
   caching will, however, still save you the time it would take to download the wheels (and it will reduce the strain on
   PyPi).

#### Caching the Poetry installation

In addition to caching your python dependencies you might find it useful to cache the Poetry installation itself. This
should cut ~10 seconds of your total runtime and roughly 95% of this action's runtime.

```yaml
name: test

on: pull_request

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - name: Check out repository
        uses: actions/checkout@v6
      - name: Set up python
        uses: actions/setup-python@v6
        with:
          python-version: '3.14'
      - name: Load cached Poetry installation
        id: cached-poetry
        uses: actions/cache@v5
        with:
          path: ~/.local  # the path depends on the OS
          key: poetry-0  # increment to reset cache
      - name: Install Poetry
        if: steps.cached-poetry.outputs.cache-hit != 'true'
        uses: snok/install-poetry@v1
```

The directory to cache will depend on the operating system of the runner.

Note that when the cache is hit, and the Install Poetry step is skipped, configuration options are not re-applied. The cached Poetry installation will now run with default settings. To make things work the same, you may add a dedicated configuration step to re-apply your configurations. For example:

```yaml
- name: Configure poetry
  if: steps.cached-poetry.outputs.cache-hit == 'true'
  run: poetry config virtualenvs.in-project true
```

Or consider using a config.toml file to store you configuration options. See details in the [Poetry configuration docs](https://python-poetry.org/docs/configuration/).

#### Installing Poetry Plugins

With Poetry 1.2 or later, you can use this action to install plugins:

```yaml
- uses: snok/install-poetry@v1
  with:
    plugins: poetry-plugin-a
```

You can use a whitespace delimited list:

```yaml
- uses: snok/install-poetry@v1
  with:
    plugins: |
      poetry-plugin-a
      poetry-plugin-b
```

## Contributing

Contributions are always welcome; submit a PR!

## License

install-poetry is licensed under an MIT license. See the license file for details.

## Showing your support

Leave a ⭐️ if this project helped you!