You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-3Lines changed: 5 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,9 @@
6
6
7
7
This action provides the following functionalities for GitHub Actions users:
8
8
9
-
- Optionally downloading and installing the requested version of Python/PyPy and adding it to the PATH
9
+
- Optionally installing and adding to PATH a version of Python that is already installed in the runner's tool cache.
10
+
- Downloading, installing and adding to PATH an available version of Python from GitHub Releases ([actions/python-versions](https://github.com/actions/python-versions/releases)) if a specific version is not available in the runner's tool cache.
11
+
- Failing if a specific version of Python is not preinstalled or available for download.
10
12
- Optionally caching dependencies for pip, pipenv and poetry
11
13
- Registering problem matchers for error output
12
14
@@ -18,7 +20,7 @@ See [action.yml](action.yml)
18
20
```yaml
19
21
steps:
20
22
- uses: actions/checkout@v3
21
-
- uses: actions/setup-python@v4# <- v4 is a major release tag of the action: https://github.com/actions/setup-python/tags
23
+
- uses: actions/setup-python@v4
22
24
with:
23
25
python-version: '3.10'
24
26
- run: python my_script.py
@@ -49,7 +51,7 @@ Using `architecture` input it is possible to specify the required Python/PyPy in
49
51
50
52
## Caching packages dependencies
51
53
52
-
The action has built-in functionality for caching and restoring dependencies. It uses [actions/cache](https://github.com/actions/toolkit/tree/main/packages/cache) under the hood for caching dependencies but requires less configuration settings. Supported package managers are `pip`, `pipenv` and `poetry`. The `cache` input is optional, and caching is turned off by default.
54
+
The action has built-in functionality for caching and restoring dependencies. It uses [toolkit/cache](https://github.com/actions/toolkit/tree/main/packages/cache) under the hood for caching dependencies but requires less configuration settings. Supported package managers are `pip`, `pipenv` and `poetry`. The `cache` input is optional, and caching is turned off by default.
53
55
54
56
The action defaults to searching for a dependency file (`requirements.txt` for pip, `Pipfile.lock` for pipenv or `poetry.lock` for poetry) in the repository, and uses its hash as a part of the cache key. Input `cache-dependency-path` is used for cases when multiple dependency files are used, they are located in different subdirectories or different files for the hash that want to be used.
-[Specifying a Python version](advanced-usage.md#specifying-a-python-version)
4
4
-[Specifying a PyPy version](advanced-usage.md#specifying-a-pypy-version)
@@ -19,11 +19,9 @@
19
19
20
20
# Using python-version input
21
21
22
-
The `python-version` input is used to specify the required version of Python or PyPy.
23
-
24
22
## Specifying a Python version
25
23
26
-
If there is a specific version of Python that you need and you don't want to worry about any potential breaking changes due to patch updates (going from `3.7.5` to `3.7.6` for example), you should specify the **exact major, minor, and patch version** (such as `3.7.5`):
24
+
If there is a specific version of Python that you need and you don't want to worry about any potential breaking changes due to patch updates (going from `3.7.5` to `3.7.6` for example), you should specify the ***exact major, minor, and patch version*** (such as `3.7.5`):
27
25
28
26
```yaml
29
27
steps:
@@ -36,7 +34,7 @@ steps:
36
34
- The only downside to this is that set-up will take a little longer since the exact version will have to be downloaded if the exact version is not already installed on the runner due to more recent versions.
37
35
- MSI installers are used on Windows for this, so runs will take a little longer to set up vs MacOS and Linux.
38
36
39
-
You can specify **only a major and minor version** if you are okay with the most recent patch version being used:
37
+
You can specify ***only a major and minor version*** if you are okay with the most recent patch version being used:
40
38
41
39
```yaml
42
40
steps:
@@ -50,7 +48,7 @@ steps:
50
48
- The patch version that will be preinstalled, will generally be the latest and every time there is a new patch released, the older version that is preinstalled will be replaced.
51
49
- Using the most recent patch version will result in a very quick setup since no downloads will be required since a locally installed version of Python on the runner will be used.
52
50
53
-
You can specify the version with **prerelease tag** to download and set up an accurate pre-release version of Python:
51
+
You can specify the version with ***prerelease tag*** to download and set up an accurate pre-release version of Python:
54
52
55
53
```yaml
56
54
steps:
@@ -61,7 +59,7 @@ steps:
61
59
- run: python my_script.py
62
60
```
63
61
64
-
It's also possible to use **x.y-dev syntax** to download and set up the latest patch version of Python, alpha and beta releases included. (for specified major & minor versions):
62
+
It's also possible to use ***x.y-dev syntax*** to download and set up the latest patch version of Python, alpha and beta releases included. (for specified major & minor versions):
65
63
66
64
```yaml
67
65
steps:
@@ -74,7 +72,7 @@ steps:
74
72
75
73
You can also use several types of ranges that are specified in [semver](https://github.com/npm/node-semver#ranges), for instance:
76
74
77
-
- **[hyphen ranges](https://github.com/npm/node-semver#hyphen-ranges-xyz---abc)** to download and set up the latest available version of Python (includes both pre-release and stable versions):
75
+
- ***[hyphen ranges](https://github.com/npm/node-semver#hyphen-ranges-xyz---abc)*** to download and set up the latest available version of Python (includes both pre-release and stable versions):
78
76
79
77
```yaml
80
78
steps:
@@ -85,7 +83,7 @@ steps:
85
83
- run: python my_script.py
86
84
```
87
85
88
-
- **[x-ranges](https://github.com/npm/node-semver#x-ranges-12x-1x-12-)** to specify the latest stable version of Python (for specified major version):
86
+
- ***[x-ranges](https://github.com/npm/node-semver#x-ranges-12x-1x-12-)*** to specify the latest stable version of Python (for specified major version):
0 commit comments