Skip to content

Commit 61fb4e4

Browse files
author
IvanZosimov
committed
Fix review points
1 parent 09086cc commit 61fb4e4

File tree

3 files changed

+9
-19
lines changed

3 files changed

+9
-19
lines changed

README.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,6 @@ This action provides the following functionality for GitHub Actions users:
1010
- Optionally caching dependencies for pip, pipenv and poetry
1111
- Registering problem matchers for error output
1212

13-
## Table of contents
14-
15-
- [Basic usage](#basic-usage)
16-
- [Supported version syntax](#supported-version-syntax)
17-
- [Supported architectures](#supported-architectures)
18-
- [Caching packages dependencies](#caching-packages-dependencies)
19-
- [Advanced usage](#advanced-usage)
20-
- [License](#license)
21-
- [Contributions](#contributions)
22-
2313
## Basic usage
2414

2515
See [action.yml](action.yml)
@@ -40,7 +30,7 @@ steps:
4030
- uses: actions/checkout@v3
4131
- uses: actions/setup-python@v4
4232
with:
43-
python-version: 'pypy3.7'
33+
python-version: 'pypy3.9'
4434
- run: python my_script.py
4535
```
4636
The `python-version` input is optional. If not supplied, the Python/PyPy version from the PATH will be used. The default version of Python/PyPy in PATH vary between runners and can be changed unexpectedly so we recommend always use `setup-python`.
@@ -51,7 +41,7 @@ For information regarding locally cached versions of Python/PyPy on GitHub hoste
5141

5242
## Supported version syntax
5343

54-
The `python-version` input supports the [Semantic Versioning Specification](https://semver.org/) and some special version notations (e.g. `semver ranges`, `x.y-dev syntax`, etc), for detailed examples please refer to the section: [Using python-version input](docs/advanced-usage.md#using-python-version-input) of the [Advanced usage](docs/advanced-usage.md) guide.
44+
The `python-version` input supports the [Semantic Versioning Specification](https://semver.org/) and some special version notations (e.g. `semver ranges`, `x.y-dev syntax`, etc.), for detailed examples please refer to the section: [Using python-version input](docs/advanced-usage.md#using-python-version-input) of the [Advanced usage](docs/advanced-usage.md) guide.
5545

5646
## Supported architectures
5747

action.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ description: 'Set up a specific version of Python and add the command-line tools
44
author: 'GitHub'
55
inputs:
66
python-version:
7-
description: "Version range or exact version of Python to use, using SemVer's version range syntax."
7+
description: 'Version range or exact version of Python/PyPy to use, using SemVer's version range syntax.'
88
python-version-file:
9-
description: "File containing the Python version to use. Example: .python-version"
9+
description: 'File containing the Python version to use. Example: .python-version'
1010
cache:
1111
description: 'Used to specify a package manager for caching in the default directory. Supported values: pip, pipenv, poetry.'
1212
required: false
1313
architecture:
14-
description: 'The target architecture (x86, x64) of the Python interpreter.'
14+
description: 'The target architecture (x86, x64) of the Python/PyPy interpreter.'
1515
token:
16-
description: Used to pull python distributions from actions/python-versions. Since there's a default, this is typically not supplied by the user.
16+
description: 'Used to pull python distributions from actions/python-versions. Since there's a default, this is typically not supplied by the user.'
1717
default: ${{ github.token }}
1818
cache-dependency-path:
1919
description: 'Used to specify the path to dependency files. Supports wildcards or a list of file names for caching multiple dependencies.'
@@ -22,11 +22,11 @@ inputs:
2222
default: true
2323
outputs:
2424
python-version:
25-
description: "The installed Python version. Useful when given a version range as input."
25+
description: 'The installed Python/PyPy version. Useful when given a version range as input.'
2626
cache-hit:
2727
description: 'A boolean value to indicate a cache entry was found'
2828
python-path:
29-
description: "The absolute path to the Python executable."
29+
description: 'The absolute path to the Python/PyPy executable.'
3030
runs:
3131
using: 'node16'
3232
main: 'dist/setup/index.js'

docs/advanced-usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ steps:
285285

286286
### `python-version`
287287

288-
Using **python-version** output it's possible to get the installed by action Pytho/PyPy version. This output is useful when the input `python-version` given as a range (e.g. 3.8.0 - 3.10.0 ), but down in a workflow you need to operate with the exact installed version (e.g. 3.10.1).
288+
Using **python-version** output it's possible to get the installed by action Python/PyPy version. This output is useful when the input `python-version` given as a range (e.g. 3.8.0 - 3.10.0 ), but down in a workflow you need to operate with the exact installed version (e.g. 3.10.1).
289289

290290
```yaml
291291
jobs:

0 commit comments

Comments
 (0)