setup-python/action.yml

44 lines
2.2 KiB
YAML
Raw Normal View History

2019-12-27 13:08:34 -05:00
---
2022-07-26 08:47:59 -04:00
name: "Setup Python"
description: "Set up a specific version of Python and add the command-line tools to the PATH."
author: "GitHub"
2019-08-20 10:27:52 -04:00
inputs:
python-version:
2022-07-28 03:38:24 -04:00
description: "Version range or exact version of Python or PyPy to use, using SemVer's version range syntax. Reads from .python-version if unset."
python-version-file:
2022-07-13 07:43:28 -04:00
description: "File containing the Python version to use. Example: .python-version"
cache:
2022-07-26 08:47:59 -04:00
description: "Used to specify a package manager for caching in the default directory. Supported values: pip, pipenv, poetry."
required: false
2019-08-20 10:27:52 -04:00
architecture:
2022-07-28 03:38:24 -04:00
description: "The target architecture (x86, x64) of the Python or PyPy interpreter."
2022-07-13 07:43:28 -04:00
check-latest:
2022-07-26 08:47:59 -04:00
description: "Set this option if you want the action to check for the latest available version that satisfies the version spec."
2022-07-13 07:43:28 -04:00
default: false
token:
description: "The token used to authenticate when fetching Python distributions from https://github.com/actions/python-versions. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting."
default: ${{ github.server_url == 'https://github.com' && github.token || '' }}
cache-dependency-path:
2022-07-26 08:47:59 -04:00
description: "Used to specify the path to dependency files. Supports wildcards or a list of file names for caching multiple dependencies."
update-environment:
2022-07-26 08:47:59 -04:00
description: "Set this option if you want the action to update environment variables."
default: true
allow-prereleases:
description: "When 'true', a version range passed to 'python-version' input will match prerelease versions if no GA versions are found. Only 'x.y' version range is supported for CPython."
default: false
outputs:
python-version:
2022-07-28 03:38:24 -04:00
description: "The installed Python or PyPy version. Useful when given a version range as input."
cache-hit:
2022-07-26 08:47:59 -04:00
description: "A boolean value to indicate a cache entry was found"
python-path:
2022-07-28 03:38:24 -04:00
description: "The absolute path to the Python or PyPy executable."
2019-08-20 10:27:52 -04:00
runs:
2022-02-25 04:31:18 -05:00
using: 'node16'
main: 'dist/setup/index.js'
post: 'dist/cache-save/index.js'
post-if: success()
branding:
2019-11-06 10:20:01 -05:00
icon: 'code'
2020-03-09 05:31:20 -04:00
color: 'yellow'