|
1 | 1 | # GitHub Action - Setup and Cache Python Poetry |
2 | 2 |
|
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. |
5 | 4 |
|
6 | 5 | When a job using this action runs for the first time, this action will download Poetry and the required project |
7 | 6 | dependencies, then save it to the cache. |
8 | 7 |
|
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]) |
11 | 9 | this action will restore the cache, which is much faster than downloading everything again. |
12 | 10 |
|
13 | 11 | ## Basic Usage |
@@ -44,14 +42,23 @@ jobs: |
44 | 42 |
|
45 | 43 | * You can see the list of cache entries by going to: |
46 | 44 | `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]. |
48 | 46 |
|
49 | 47 | ## Dependencies |
50 | 48 |
|
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]. |
54 | 52 |
|
55 | 53 | ## License |
56 | 54 |
|
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 |
0 commit comments