Merge branch 'main' into v-dmshib/add-check-latest

.github/workflows/test-python.yml

@@ -10,33 +10,9 @@ on:
       - '**.md'
   schedule:
     - cron: 30 3 * * *
+  workflow_dispatch:
 
 jobs:
-  default-version:
-    name: Setup default version
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [macos-latest, windows-latest, ubuntu-18.04, ubuntu-20.04]
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v2
-
-    - name: setup default python
-      id: setup-python
-      uses: ./
-
-    - name: Check python-path
-      run: ./__tests__/check-python-path.sh '${{ steps.setup-python.outputs.python-path }}'
-      shell: bash
-
-    - name: Validate version
-      run: python --version
-
-    - name: Run simple python code
-      run: python -c 'import math; print(math.factorial(5))'
-
   setup-versions-from-manifest:
     name: Setup ${{ matrix.python }} ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
@@ -47,7 +23,7 @@ jobs:
         python: [3.5.4, 3.6.7, 3.7.5, 3.8.1]
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: setup-python ${{ matrix.python }}
       id: setup-python
@@ -72,6 +48,44 @@ jobs:
     - name: Run simple code
       run: python -c 'import math; print(math.factorial(5))'
 
+  setup-versions-from-file:
+    name: Setup ${{ matrix.python }} ${{ matrix.os }} version file
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, windows-latest, ubuntu-18.04, ubuntu-20.04]
+        python: [3.5.4, 3.6.7, 3.7.5, 3.8.1]
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: build-version-file ${{ matrix.python }}
+      run: echo ${{ matrix.python }} > .python-version
+
+    - name: setup-python ${{ matrix.python }}
+      id: setup-python
+      uses: ./
+      with:
+        python-version-file: '.python-version'
+
+    - name: Check python-path
+      run: ./__tests__/check-python-path.sh '${{ steps.setup-python.outputs.python-path }}'
+      shell: bash
+
+    - name: Validate version
+      run: |
+        $pythonVersion = (python --version)
+        if ("Python ${{ matrix.python }}" -ne "$pythonVersion"){
+          Write-Host "The current version is $pythonVersion; expected version is ${{ matrix.python }}"
+          exit 1
+        }
+        $pythonVersion
+      shell: pwsh
+
+    - name: Run simple code
+      run: python -c 'import math; print(math.factorial(5))'
+
   setup-pre-release-version-from-manifest:
     name: Setup 3.9.0-beta.4 ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
@@ -81,7 +95,7 @@ jobs:
         os: [macos-latest, windows-latest, ubuntu-18.04, ubuntu-20.04]
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: setup-python 3.9.0-beta.4
       id: setup-python
@@ -106,11 +120,17 @@ jobs:
     - name: Run simple code
       run: python -c 'import math; print(math.factorial(5))'
 
+<<<<<<< HEAD
   check-latest:
+=======
+  setup-dev-version:
+    name: Setup 3.9-dev ${{ matrix.os }}
+>>>>>>> main
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
+<<<<<<< HEAD
         os: [ubuntu-latest, windows-latest, macos-latest]
         python-version: ["3.8", "3.9", "3.10"]
     steps:
@@ -129,3 +149,26 @@ jobs:
           }
           $pythonVersion
         shell: pwsh
+=======
+        os: [macos-latest, windows-latest, ubuntu-latest]
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: setup-python 3.9-dev
+      id: setup-python
+      uses: ./
+      with:
+        python-version: '3.9-dev'
+
+    - name: Check python-path
+      run: ./__tests__/check-python-path.sh '${{ steps.setup-python.outputs.python-path }}'
+      shell: bash
+
+    - name: Validate version
+      run: ${{ startsWith(steps.setup-python.outputs.python-version, '3.9.') }}
+      shell: bash
+
+    - name: Run simple code
+      run: python -c 'import math; print(math.factorial(5))'
+>>>>>>> main

README.md

@@ -1,4 +1,4 @@
-# setup-python V3
+# setup-python V4
 
 <p align="left">
   <a href="https://github.com/actions/setup-python"><img alt="GitHub Actions status" src="https://github.com/actions/setup-python/workflows/Main%20workflow/badge.svg"></a>
@@ -20,6 +20,7 @@ This action sets up a Python environment for use in actions by:
 - Support for pre-release versions of Python.
 - Support for installing any version of PyPy on-flight
 - Support for built-in caching of pip, pipenv and poetry dependencies
+- Support for `.python-version` file
 
 # Usage
 
@@ -29,13 +30,23 @@ Basic:
 ```yaml
 steps:
 - uses: actions/checkout@v3
-- uses: actions/setup-python@v3
+- uses: actions/setup-python@v4
   with:
     python-version: '3.x' # Version range or exact version of a Python version to use, using SemVer's version range syntax
     architecture: 'x64' # optional x64 or x86. Defaults to x64 if not specified
 - run: python my_script.py
 ```
 
+Read Python version from file:
+```yaml
+steps:
+- uses: actions/checkout@v3
+- uses: actions/setup-python@v4
+  with:
+    python-version-file: '.python-version' # Read python version from a file
+- run: python my_script.py
+```
+
 Matrix Testing:
 ```yaml
 jobs:
@@ -48,7 +59,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
           architecture: x64
@@ -72,7 +83,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Display Python version
@@ -90,7 +101,7 @@ jobs:
         python-version: ['3.7.4', '3.8', '3.9', '3.10']
     steps:
     - uses: actions/checkout@v3
-    - uses: actions/setup-python@v3
+    - uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
     - run: python my_script.py
@@ -100,7 +111,7 @@ Download and set up an accurate pre-release version of Python:
 ```yaml
 steps:
 - uses: actions/checkout@v3
-- uses: actions/setup-python@v3
+- uses: actions/setup-python@v4
   with:
     python-version: '3.11.0-alpha.1'
 - run: python my_script.py
@@ -110,7 +121,7 @@ Download and set up the latest available version of Python (includes both pre-re
 ```yaml
 steps:
 - uses: actions/checkout@v3
-- uses: actions/setup-python@v3
+- uses: actions/setup-python@v4
   with:
     python-version: '3.11.0-alpha - 3.11.0' # SemVer's version range syntax
 - run: python my_script.py
@@ -130,7 +141,7 @@ jobs:
         - 'pypy3.8' # the latest available version of PyPy that supports Python 3.8
     steps:
     - uses: actions/checkout@v3
-    - uses: actions/setup-python@v3
+    - uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
     - run: python my_script.py
@@ -144,13 +155,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
-    - uses: actions/setup-python@v3
+    - uses: actions/setup-python@v4
       id: cp310
       with:
         python-version: "3.10"
     - run: pipx run --python '${{ steps.cp310.outputs.python-path }}' nox --version
 ```
 
+>The environment variable `pythonLocation` also becomes available after Python or PyPy installation. It contains the absolute path to the folder where the desired version of Python or PyPy is installed.
+
 # Getting started with Python + Actions
 
 Check out our detailed guide on using [Python with GitHub Actions](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/using-python-with-github-actions).
@@ -164,7 +177,7 @@ Check out our detailed guide on using [Python with GitHub Actions](https://help.
     - For every minor version of Python, expect only the latest patch to be preinstalled.
     - If `3.8.1` is installed for example, and `3.8.2` is released, expect `3.8.1` to be removed and replaced by `3.8.2` in the tools cache.
     - If the exact patch version doesn't matter to you, specifying just the major and minor version will get you the latest preinstalled patch version. In the previous example, the version spec `3.8` will use the `3.8.2` Python version found in the cache.
-    - Use `-dev` instead of a patch number (e.g., `3.11-dev`) to install the latest release of a minor version, *alpha and beta releases included*.
+    - Use `-dev` instead of a patch number (e.g., `3.11-dev`) to install the latest patch version release for a given minor version, *alpha and beta releases included*.
 - Downloadable Python versions from GitHub Releases ([actions/python-versions](https://github.com/actions/python-versions/releases)).
     - All available versions are listed in the [version-manifest.json](https://github.com/actions/python-versions/blob/main/versions-manifest.json) file.
     - If there is a specific version of Python that is not available, you can open an issue here
@@ -224,6 +237,8 @@ pypy3.7-v7.3.3rc1 or pypy-3.7-v7.3.3rc1 # Python 3.7 and preview version of PyPy
 pypy3.7-nightly or pypy-3.7-nightly # Python 3.7 and nightly PyPy
 ```
 
+Note: `pypy2` and `pypy3` have been removed in v3. Use the format above instead.
+
 # Check latest version
 
 The `check-latest` flag defaults to `false`. Use the default or set `check-latest` to `false` if you prefer stability and if you want to ensure a specific `Python/PyPy` version is always used.
@@ -261,7 +276,7 @@ The requirements file format allows to specify dependency versions using logical
 ```yaml
 steps:
 - uses: actions/checkout@v3
-- uses: actions/setup-python@v3
+- uses: actions/setup-python@v4
   with:
     python-version: '3.9'
     cache: 'pip'
@@ -274,7 +289,7 @@ steps:
 - uses: actions/checkout@v3
 - name: Install pipenv
   run: pipx install pipenv
-- uses: actions/setup-python@v3
+- uses: actions/setup-python@v4
   with:
     python-version: '3.9'
     cache: 'pipenv'
@@ -287,7 +302,7 @@ steps:
 - uses: actions/checkout@v3
 - name: Install poetry
   run: pipx install poetry
-- uses: actions/setup-python@v3
+- uses: actions/setup-python@v4
   with:
     python-version: '3.9'
     cache: 'poetry'
@@ -299,7 +314,7 @@ steps:
 ```yaml
 steps:
 - uses: actions/checkout@v3
-- uses: actions/setup-python@v3
+- uses: actions/setup-python@v4
   with:
     python-version: '3.9'
     cache: 'pip'
@@ -313,7 +328,7 @@ steps:
 - uses: actions/checkout@v3
 - name: Install pipenv
   run: pipx install pipenv
-- uses: actions/setup-python@v3
+- uses: actions/setup-python@v4
   with:
     python-version: '3.9'
     cache: 'pipenv'
@@ -369,7 +384,14 @@ If you are experiencing problems while configuring Python on your self-hosted ru
 
 `setup-python` comes pre-installed on the appliance with GHES if Actions is enabled. When dynamically downloading Python distributions, `setup-python` downloads distributions from [`actions/python-versions`](https://github.com/actions/python-versions) on github.com (outside of the appliance). These calls to `actions/python-versions` are made via unauthenticated requests, which are limited to [60 requests per hour per IP](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting). If more requests are made within the time frame, then you will start to see rate-limit errors during download that read `##[error]API rate limit exceeded for...`.
 
-To avoid hitting rate-limit problems, we recommend [setting up your own runner tool cache](https://docs.github.com/en/enterprise-server@2.22/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access#about-the-included-setup-actions-and-the-runner-tool-cache).
+To get a higher rate limit, you can [generate a personal access token on github.com](https://github.com/settings/tokens/new) and pass it as the `token` input for the action:
+
+```yml
+uses: actions/setup-python@v4
+with:
+  token: ${{ secrets.GH_DOTCOM_TOKEN }}
+  python-version: 3.11
+```
 
 # License
 

action.yml

@@ -4,8 +4,9 @@ description: 'Set up a specific version of Python and add the command-line tools
 author: 'GitHub'
 inputs:
   python-version:
-    description: "Version range or exact version of a Python version to use, using SemVer's version range syntax."
+    description: "Version range or exact version of Python to use, using SemVer's version range syntax. Reads from .python-version if unset."
-    default: '3.x'
+  python-version-file:
+    description: "File containing the Python version to use. Example: .python-version"
   cache:
     description: 'Used to specify a package manager for caching in the default directory. Supported values: pip, pipenv, poetry.'
     required: false
@@ -15,7 +16,7 @@ inputs:
     description: 'Set this option if you want the action to check for the latest available version that satisfies the version spec.'
     default: false
   token:
-    description: Used to pull python distributions from actions/python-versions. Since there's a default, this is typically not supplied by the user.
+    description: The token used to authenticate when to 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.token }}
   cache-dependency-path:
     description: 'Used to specify the path to dependency files. Supports wildcards or a list of file names for caching multiple dependencies.'

docs/adrs/0000-caching-dependencies.md

@@ -45,8 +45,8 @@ We won't pursue the goal to provide wide customization of caching in the scope o
 
 ```
 steps:
-- uses: actions/checkout@v2
+- uses: actions/checkout@v3
-- uses: actions/setup-python@v2
+- uses: actions/setup-python@v4
   with:
     python-version: 3.9
     cache: pip
@@ -56,8 +56,8 @@ steps:
 
 ```
 steps:
-- uses: actions/checkout@v2
+- uses: actions/checkout@v3
-- uses: actions/setup-python@v2
+- uses: actions/setup-python@v4
   with:
     python-version: 3.9
     cache: pipenv
@@ -66,8 +66,8 @@ steps:
 
 ```
 steps:
-- uses: actions/checkout@v2
+- uses: actions/checkout@v3
-- uses: actions/setup-python@v2
+- uses: actions/setup-python@v4
   with:
     python-version: 3.9
     cache: pip
@@ -80,8 +80,8 @@ steps:
 
 ```
 steps:
-- uses: actions/checkout@v2
+- uses: actions/checkout@v3
-- uses: actions/setup-python@v2
+- uses: actions/setup-python@v4
   with:
     python-version: 3.9
     cache: pip

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "setup-python",
-  "version": "3.1.1",
+  "version": "4.0.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "setup-python",
-      "version": "3.1.1",
+      "version": "4.0.0",
       "license": "MIT",
       "dependencies": {
         "@actions/cache": "^2.0.2",
@@ -21,7 +21,7 @@
         "@types/jest": "^27.0.2",
         "@types/node": "^16.11.25",
         "@types/semver": "^7.1.0",
-        "@zeit/ncc": "^0.22.0",
+        "@vercel/ncc": "^0.33.4",
         "husky": "^7.0.2",
         "jest": "^27.2.5",
         "jest-circus": "^27.2.5",
@@ -3918,11 +3918,10 @@
       "integrity": "sha512-FA/BWv8t8ZWJ+gEOnLLd8ygxH/2UFbAvgEonyfN6yWGLKc7zVjbpl2Y4CTjid9h2RfgPP6SEt6uHwEOply00yw==",
       "dev": true
     },
-    "node_modules/@zeit/ncc": {
+    "node_modules/@vercel/ncc": {
-      "version": "0.22.0",
+      "version": "0.33.4",
-      "resolved": "https://registry.npmjs.org/@zeit/ncc/-/ncc-0.22.0.tgz",
+      "resolved": "https://registry.npmjs.org/@vercel/ncc/-/ncc-0.33.4.tgz",
-      "integrity": "sha512-zaS6chwztGSLSEzsTJw9sLTYxQt57bPFBtsYlVtbqGvmDUsfW7xgXPYofzFa1kB9ur2dRop6IxCwPnWLBVCrbQ==",
+      "integrity": "sha512-ln18hs7dMffelP47tpkaR+V5Tj6coykNyxJrlcmCormPqRQjB/Gv4cu2FfBG+PMzIfdZp2CLDsrrB1NPU22Qhg==",
-      "deprecated": "@zeit/ncc is no longer maintained. Please use @vercel/ncc instead.",
       "dev": true,
       "bin": {
         "ncc": "dist/ncc/cli.js"
@@ -14502,10 +14501,10 @@
       "integrity": "sha512-FA/BWv8t8ZWJ+gEOnLLd8ygxH/2UFbAvgEonyfN6yWGLKc7zVjbpl2Y4CTjid9h2RfgPP6SEt6uHwEOply00yw==",
       "dev": true
     },
-    "@zeit/ncc": {
+    "@vercel/ncc": {
-      "version": "0.22.0",
+      "version": "0.33.4",
-      "resolved": "https://registry.npmjs.org/@zeit/ncc/-/ncc-0.22.0.tgz",
+      "resolved": "https://registry.npmjs.org/@vercel/ncc/-/ncc-0.33.4.tgz",
-      "integrity": "sha512-zaS6chwztGSLSEzsTJw9sLTYxQt57bPFBtsYlVtbqGvmDUsfW7xgXPYofzFa1kB9ur2dRop6IxCwPnWLBVCrbQ==",
+      "integrity": "sha512-ln18hs7dMffelP47tpkaR+V5Tj6coykNyxJrlcmCormPqRQjB/Gv4cu2FfBG+PMzIfdZp2CLDsrrB1NPU22Qhg==",
       "dev": true
     },
     "abab": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "setup-python",
-  "version": "3.1.1",
+  "version": "4.0.0",
   "private": true,
   "description": "Setup python action",
   "main": "dist/index.js",
@@ -35,7 +35,7 @@
     "@types/jest": "^27.0.2",
     "@types/node": "^16.11.25",
     "@types/semver": "^7.1.0",
-    "@zeit/ncc": "^0.22.0",
+    "@vercel/ncc": "^0.33.4",
     "husky": "^7.0.2",
     "jest": "^27.2.5",
     "jest-circus": "^27.2.5",

src/cache-distributions/poetry-cache.ts

@@ -58,7 +58,7 @@ class PoetryCache extends CacheDistributor {
     const config: any = {};
 
     for (let line of lines) {
-      line = line.replace(/#.*$/, '');
+      line = line.replace(/#.*$/gm, '');
 
       const [key, value] = line.split('=').map(part => part.trim());
 

src/find-pypy.ts

@@ -82,7 +82,7 @@ export async function findPyPyVersion(
     `python${binaryExtension}`
   );
   const pythonLocation = pypyInstall.getPyPyBinaryPath(installDir);
-  core.exportVariable('pythonLocation', pythonLocation);
+  core.exportVariable('pythonLocation', installDir);
   core.exportVariable('PKG_CONFIG_PATH', pythonLocation + '/lib/pkgconfig');
   core.addPath(pythonLocation);
   core.addPath(_binDir);

src/find-python.ts

@@ -140,14 +140,10 @@ export async function useCpythonVersion(
   return {impl: 'CPython', version: installed};
 }
 
-/** Convert versions like `3.8-dev` to a version like `>= 3.8.0-a0`. */
+/** Convert versions like `3.8-dev` to a version like `~3.8.0-0`. */
 function desugarDevVersion(versionSpec: string) {
-  if (versionSpec.endsWith('-dev')) {
+  const devVersion = /^(\d+)\.(\d+)-dev$/;
-    const versionRoot = versionSpec.slice(0, -'-dev'.length);
+  return versionSpec.replace(devVersion, '~$1.$2.0-0');
-    return `>= ${versionRoot}.0-a0`;
-  } else {
-    return versionSpec;
-  }
 }
 
 /** Extracts python version from install path from hosted tool cache as described in README.md */

src/install-python.ts

@@ -3,10 +3,10 @@ import * as core from '@actions/core';
 import * as tc from '@actions/tool-cache';
 import * as exec from '@actions/exec';
 import {ExecOptions} from '@actions/exec/lib/interfaces';
-import {IS_WINDOWS, IS_LINUX, isGhes} from './utils';
+import {IS_WINDOWS, IS_LINUX} from './utils';
 
 const TOKEN = core.getInput('token');
-const AUTH = !TOKEN || isGhes() ? undefined : `token ${TOKEN}`;
+const AUTH = !TOKEN ? undefined : `token ${TOKEN}`;
 const MANIFEST_REPO_OWNER = 'actions';
 const MANIFEST_REPO_NAME = 'python-versions';
 const MANIFEST_REPO_BRANCH = 'main';

src/setup-python.ts

@@ -3,6 +3,7 @@ import * as finder from './find-python';
 import * as finderPyPy from './find-pypy';
 import * as path from 'path';
 import * as os from 'os';
+import fs from 'fs';
 import {getCacheDistributor} from './cache-distributions/cache-factory';
 import {isCacheFeatureAvailable} from './utils';
 
@@ -21,6 +22,35 @@ async function cacheDependencies(cache: string, pythonVersion: string) {
   await cacheDistributor.restoreCache();
 }
 
+function resolveVersionInput(): string {
+  let version = core.getInput('python-version');
+  const versionFile = core.getInput('python-version-file');
+
+  if (version && versionFile) {
+    core.warning(
+      'Both python-version and python-version-file inputs are specified, only python-version will be used'
+    );
+  }
+
+  if (version) {
+    return version;
+  }
+
+  const versionFilePath = path.join(
+    process.env.GITHUB_WORKSPACE!,
+    versionFile || '.python-version'
+  );
+  if (!fs.existsSync(versionFilePath)) {
+    throw new Error(
+      `The specified python version file at: ${versionFilePath} does not exist`
+    );
+  }
+  version = fs.readFileSync(versionFilePath, 'utf8');
+  core.info(`Resolved ${versionFile} as ${version}`);
+
+  return version;
+}
+
 async function run() {
   if (process.env.AGENT_TOOLSDIRECTORY?.trim()) {
     core.debug(
@@ -33,8 +63,9 @@ async function run() {
     );
   }
   try {
-    const version = core.getInput('python-version');
+    const version = resolveVersionInput();
     const checkLatest = core.getBooleanInput('check-latest');
+
     if (version) {
       let pythonVersion: string;
       const arch: string = core.getInput('architecture') || os.arch();