2019-12-28 02:08:34 +08:00
---
2022-07-26 20:47:59 +08: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 22:27:52 +08:00
inputs :
python-version :
2022-07-28 15:38:24 +08: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."
2022-06-02 22:37:57 +08:00
python-version-file :
2022-07-13 19:43:28 +08:00
description : "File containing the Python version to use. Example: .python-version"
2021-11-17 18:31:22 +08:00
cache :
2022-07-26 20:47:59 +08:00
description : "Used to specify a package manager for caching in the default directory. Supported values: pip, pipenv, poetry."
2021-11-17 18:31:22 +08:00
required : false
2019-08-20 22:27:52 +08:00
architecture :
2022-07-28 15:38:24 +08:00
description : "The target architecture (x86, x64) of the Python or PyPy interpreter."
2022-07-13 19:43:28 +08:00
check-latest :
2022-07-26 20:47:59 +08: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 19:43:28 +08:00
default : false
2023-08-24 06:29:55 +08:00
github_api_url :
description : "The url you wish to gather Python distributions from. Useful when running on GHES when you have a local instance of actions/python-versions and actions/setup-python installed"
default : "https://api.github.com"
github_raw_url :
description : "The endpoint you wish to use as the raw url"
default : "https://raw.githubusercontent.com"
2020-04-30 01:57:02 +08:00
token :
2022-08-31 03:02:20 +08:00
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."
2023-08-24 15:04:56 +08:00
default : ${{ github.github_api_url == inputs.github_api_url && github.token || '' }}
2021-11-17 18:31:22 +08:00
cache-dependency-path :
2022-07-26 20:47:59 +08:00
description : "Used to specify the path to dependency files. Supports wildcards or a list of file names for caching multiple dependencies."
2022-06-29 23:00:51 +08:00
update-environment :
2022-07-26 20:47:59 +08:00
description : "Set this option if you want the action to update environment variables."
2022-06-29 23:00:51 +08:00
default : true
2023-01-28 05:19:31 +08:00
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
2020-03-09 15:18:12 +08:00
outputs :
python-version :
2022-07-28 15:38:24 +08:00
description : "The installed Python or PyPy version. Useful when given a version range as input."
2022-04-05 21:57:13 +08:00
cache-hit :
2022-07-26 20:47:59 +08:00
description : "A boolean value to indicate a cache entry was found"
2022-05-24 02:59:37 +08:00
python-path :
2022-07-28 15:38:24 +08:00
description : "The absolute path to the Python or PyPy executable."
2019-08-20 22:27:52 +08:00
runs :
2022-02-25 17:31:18 +08:00
using : 'node16'
2021-11-17 18:31:22 +08:00
main : 'dist/setup/index.js'
post : 'dist/cache-save/index.js'
post-if : success()
2019-11-06 06:12:58 +08:00
branding :
2019-11-06 23:20:01 +08:00
icon : 'code'
2020-03-09 17:31:20 +08:00
color : 'yellow'