From 0dd19c9498c3dc8728967849d0d2eae428a8a3d8 Mon Sep 17 00:00:00 2001 From: Aaron Batilo Date: Wed, 1 Jan 2025 15:21:28 -0700 Subject: [PATCH] docs: Update documentation and ci to reflect v4 (#84) --- .github/workflows/ci.yml | 12 +++++------- README.md | 15 +++++++++++++-- 2 files changed, 18 insertions(+), 9 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 3a7bc25..edf4c62 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -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 diff --git a/README.md b/README.md index 13fbf46..1cf6511 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 @@ -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