Skip to content

Commit

Permalink
docs: Update documentation and ci to reflect v4 (#84)
Browse files Browse the repository at this point in the history
  • Loading branch information
abatilo authored Jan 1, 2025
1 parent 3765cf6 commit 0dd19c9
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 9 deletions.
12 changes: 5 additions & 7 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,8 @@ jobs:
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
# Temporarily disable as we merge #82 which will bump major version
# git tag -d v3
# git push --delete origin v3
# git push origin :refs/tags/v3
# git tag v3
# git push --tags
git tag -d v4
git push --delete origin v4
git push origin :refs/tags/v4
git tag v4
git push --tags
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,17 @@ GitHub Actions for Python projects using poetry

## Getting started

### Breaking changes for v4

As of #82, we've removed the changes that were in v3, since `pipx` is installed
on recent versions of GitHub Action runners by default.

### Breaking changes for v3

We've started installing `poetry` with `pipx` to keep the installed artifacts
isolated away from any of your application dependencies. v3 will install `pipx`
for you as well.

### Breaking changes for v2

We've drastically simplified this GitHub Action for v2.
Expand Down Expand Up @@ -39,7 +50,7 @@ jobs:
with:
python-version: ${{ matrix.python-version }}
- name: Run image
uses: abatilo/actions-poetry@v2
uses: abatilo/actions-poetry@v4
with:
poetry-version: ${{ matrix.poetry-version }}
- name: View poetry --help
Expand Down Expand Up @@ -88,7 +99,7 @@ jobs:
# see details (matrix, python-version, python-version-file, etc.)
# https://github.com/actions/setup-python
- name: Install poetry
uses: abatilo/actions-poetry@v2
uses: abatilo/actions-poetry@v4
- name: Setup a local virtual environment (if no poetry.toml file)
run: |
poetry config virtualenvs.create true --local
Expand Down

0 comments on commit 0dd19c9

Please sign in to comment.