Skip to content

Commit

Permalink
[chore] update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Gr1N committed Dec 26, 2022
1 parent 6defaa1 commit 15821dc
Showing 1 changed file with 29 additions and 23 deletions.
52 changes: 29 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,17 @@ This action sets up a [Poetry](https://python-poetry.org) for use in actions by

This action supports versions of:

- Python `>=3.6`;
- Poetry `>=1.0`.
- Python `>=3.7`
- Poetry `>=1.0`

## Changelog

### v8

- Action updated to use Node 16
- Support for Python 3.10 and 3.11
- **Breaking Change**, removed support for Python 3.6

### v7

- **Fix**, support MacOS platform #21
Expand All @@ -30,37 +36,37 @@ This action supports versions of:

```yaml
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v1
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: 3.8
- uses: Gr1N/setup-poetry@v7
python-version: "3.11"
- uses: Gr1N/setup-poetry@v8
- run: poetry --version
```
### Exact version of Poetry to install, using SemVer's version syntax
```yaml
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v1
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: 3.8
- uses: Gr1N/setup-poetry@v7
python-version: "3.11"
- uses: Gr1N/setup-poetry@v8
with:
poetry-version: 1.1.7
poetry-version: "1.2.2"
- run: poetry --version
```
### Allow to install prerelease versions of Poetry
```yaml
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v1
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: 3.8
- uses: Gr1N/setup-poetry@v7
python-version: "3.11"
- uses: Gr1N/setup-poetry@v8
with:
poetry-preview: true
- run: poetry --version
Expand All @@ -70,11 +76,11 @@ steps:
```yaml
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v1
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: 3.8
- uses: Gr1N/setup-poetry@v7
python-version: "3.11"
- uses: Gr1N/setup-poetry@v8
- uses: actions/cache@v2
with:
path: ~/.cache/pypoetry/virtualenvs
Expand All @@ -90,11 +96,11 @@ A full list of available settings can be found at [official documentation](https
```yaml
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v1
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: 3.8
- uses: Gr1N/setup-poetry@v7
python-version: "3.11"
- uses: Gr1N/setup-poetry@v8
- run: poetry --version
env:
POETRY_VIRTUALENVS_PATH: /path/to/virtualenvs/directory
Expand Down

0 comments on commit 15821dc

Please sign in to comment.