Skip to content

Commit 95b7746

Browse files
committed
chore:update versions
1 parent f13cd87 commit 95b7746

3 files changed

Lines changed: 27 additions & 11 deletions

File tree

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Setup Python Poetry with Cache GitHub Action Changelog
2+
3+
## v2
4+
5+
- Update to use `actions/cache@v4`
6+
7+
## v1
8+
9+
- Initial

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
# GitHub Action - Setup and Cache Python Poetry
22

3-
This action simplifies the setup and caching of Poetry,
4-
and provides the following functionality for GitHub Actions users:
3+
This GitHub action simplifies the setup and caching of Poetry dependencies for Python projects.
54

65
When a job using this action runs for the first time, this action will download Poetry and the required project
76
dependencies, then save it to the cache.
87

9-
For the following runs (whether it's on a different
10-
workflow/job [with the same cached commit](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache))
8+
For the following runs (whether it's on a different workflow/job [with the same cached commit][1])
119
this action will restore the cache, which is much faster than downloading everything again.
1210

1311
## Basic Usage
@@ -44,14 +42,23 @@ jobs:
4442
4543
* You can see the list of cache entries by going to:
4644
`Repo` -> `Actions` tab -> `Caches` under `Managements` (left navbar, at the bottom).
47-
* [Don't forget the limitation of cache](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy).
45+
* [Don't forget the limitation of cache][2].
4846

4947
## Dependencies
5048

51-
* Python setup using [`actions/setup-python`](https://github.com/actions/setup-python).
52-
* Poetry install using [`snok/install-poetry`](https://github.com/snok/install-poetry).
53-
* Poetry binary and dependency caching using [`actions/cache`](https://github.com/actions/cache).
49+
* Python setup using [`actions/setup-python`][3].
50+
* Poetry install using [`snok/install-poetry`][4].
51+
* Poetry binary and dependency caching using [`actions/cache`][5].
5452

5553
## License
5654

57-
The scripts and documentation in this project are released under the [MIT License](LICENSE).
55+
The scripts and documentation in this project are released under the [MIT License][6].
56+
57+
58+
59+
[1]:https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache
60+
[2]:https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy
61+
[3]:https://github.com/actions/setup-python
62+
[4]:https://github.com/snok/install-poetry
63+
[5]:https://github.com/actions/cache
64+
[6]:LICENSE

action.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ runs:
2424
# Install Poetry
2525
- name: Load cached Poetry Binary
2626
id: cached-poetry-binary
27-
uses: actions/cache@v3
27+
uses: actions/cache@v4
2828
with:
2929
path: ~/.local
3030
key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ inputs.poetry-version }}
@@ -39,7 +39,7 @@ runs:
3939
# Load cached venv if cache exists
4040
- name: Load cached venv
4141
id: cached-poetry-dependencies
42-
uses: actions/cache@v3
42+
uses: actions/cache@v4
4343
with:
4444
path: .venv
4545
key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}

0 commit comments

Comments
 (0)