Skip to content

Commit

Permalink
Improve cache Poetry install instructions
Browse files Browse the repository at this point in the history
See #150.
sebastian-correa authored and sondrelg committed Jul 23, 2024
1 parent d80b6da commit 929c2d5
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -510,6 +510,16 @@ jobs:

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:

0 comments on commit 929c2d5

Please sign in to comment.