actions/setup-pdm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Compare commits

base: actions:main
Branches Tags
actions:main
actions:v4
actions:v4.4
actions:v4.3
actions:v4.2
actions:v4.1
actions:v3.3
actions:v3
actions:v3.2
actions:v3.1
actions:v2
actions:v2.7
actions:v2.6
actions:v2.5
actions:v2.4
actions:v2.3
actions:v2.2
actions:v2.1
actions:v1.2
actions:v1.1
actions:v1
..
compare: actions:v3
Branches Tags
actions:main
actions:v4
actions:v4.4
actions:v4.3
actions:v4.2
actions:v4.1
actions:v3.3
actions:v3
actions:v3.2
actions:v3.1
actions:v2
actions:v2.7
actions:v2.6
actions:v2.5
actions:v2.4
actions:v2.3
actions:v2.2
actions:v2.1
actions:v1.2
actions:v1.1
actions:v1

No commits in common. "main" and "v3" have entirely different histories.
main ... v3

17 changed files with 88045 additions and 92310 deletions
Show Stats Expand all files Collapse all files

9
.github/workflows/ci.yml vendored
View File

@ -1,7 +1,4 @@
on: on: [push]
push:
branches: [main]
pull_request:
name: Test Action name: Test Action
@ -10,8 +7,8 @@ jobs:
runs-on: ${{ matrix.os }} runs-on: ${{ matrix.os }}
strategy: strategy:
matrix: matrix:
python-version: ['3.9', '3.10', '3.11', '3.12', '3.13'] python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
os: [windows-latest, ubuntu-latest, macos-latest] os: ["windows-latest", "ubuntu-latest", "macos-latest"]
name: Test the action name: Test the action
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3

62
README.md
View File

@ -4,54 +4,48 @@ A GitHub Action that installs pdm properly for all Python versions
## Why do I need this action? ## Why do I need this action?
Nowadays the main reason to use this action is that `actions/setup-python` [doesn't support](https://github.com/actions/setup-python/issues/587#issuecomment-1455797407) caching for PDM out of the box while `setup-pdm` does. As you know, PDM requires Python 3.7 and higher to install the package, while till now(March 2021) Python 3.6 is still widely used by many libraries. The version requirement will prevent potential users from adopting PDM. However, it is a misunderstanding, PDM CAN run projects using Python 3.6 or even Python 2!
But it is still not obvious and it is a pain for developers to properly build their CI workflows. So I made `pdm-project/setup-pdm` to solve the problem. It is PDM-for-CI done right!
Historically, this action made it easier to use PDM in repos where the Python version in use was older than the Python version required by PDM. PDM requires >=3.8 but works for projects using older versions.
## Usage ## Usage
Include the action in your workflow yaml: Include the action in your workflow yaml file with the following arguments:
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v4 ...
- name: Setup PDM - uses: pdm-project/setup-pdm@v3
uses: pdm-project/setup-pdm@v4 name: Setup PDM
# You are now able to use PDM in your workflow with:
- name: Install dependencies python-version: 3.9 # Version range or exact version of a Python version to use, the same as actions/setup-python
run: pdm install architecture: x64 # The target architecture (x86, x64) of the Python interpreter. the same as actions/setup-python
version: 2.7.4 # The version of PDM to install. Leave it as empty to use the latest version from PyPI, or 'head' to use the latest version from GitHub
prerelease: false # Allow prerelease versions of PDM to be installed
enable-pep582: false # Enable PEP 582 package loading globally
allow-python-prereleases: false # Allow prerelease versions of Python to be installed. For example if only 3.12-dev is available, 3.12 will fallback to 3.12-dev
update-python: true # Update the environment with the requested python version
- name: Install dependencies
run: pdm install # Then you can use pdm in the following steps.
...
``` ```
You don't need `actions/setup-python` actually. You don't need `actions/setup-python` actually.
## Action Inputs
This action supports the following inputs:
| Input | Default | Description |
| -------------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `python-version` | Not specified | Version range or exact version of a Python version to use, using SemVer's version range syntax. |
| `python-version-file` | `pyproject.toml` | File containing the Python version to use. Example: .`python-version` |
| `architecture` | `x64` | The target architecture (x86, x64, arm64) of the Python interpreter. |
| `allow-python-prereleases` | `false` | Allow prerelease versions of Python to be installed. |
| `token` | `${{ github.token }}` | Used to pull python distributions from actions/python-versions. Since there's a default, this is typically not supplied by the user. |
| `version` | Not specified | The version of PDM to install, or 'head' to install from the main branch. |
| `prerelease` | `false` | Allow prerelease versions of PDM to be installed |
| `enable-pep582` | `false` | Enable PEP 582 package loading globally. |
| `cache` | `false` | Cache PDM installation. |
| `cache-dependency-path` | `pdm.lock` | The dependency file(s) to cache. |
| `update-python` | `true` | Whether to update the environment with the requested Python |
## Action Outputs ## Action Outputs
This action also exposes the following outputs: This action also exposes the following outputs:
| Output | Description | ```yaml
| ---------------- | --------------------------------------------------------------------------------- | outputs:
| `python-version` | The installed Python or PyPy version. Useful when given a version range as input. | python-version:
| `python-path` | The absolute path to the Python or PyPy executable. | description: "The installed Python or PyPy version. Useful when given a version range as input."
| `pdm-version` | The installed PDM version. | python-path:
| `pdm-bin` | The absolute path to the PDM executable. | description: "The absolute path to the Python or PyPy executable."
pdm-version:
description: "The installed PDM version."
pdm-bin:
description: "The absolute path to the PDM executable."
```
## Caches ## Caches

62
action.yml
View File

@ -1,18 +1,18 @@
--- ---
name: Setup PDM name: "Setup PDM"
description: Set up a specific version of PDM and uses a given Python version to work on description: "Set up a specific version of PDM and uses a given Python version to work on"
author: Frost Ming author: "Frost Ming"
inputs: inputs:
python-version: 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 a Python version to use, using SemVer's version range syntax."
python-version-file: default: "3.x"
description: 'File containing the Python version to use. Example: .python-version' required: false
architecture: architecture:
description: 'The target architecture (x86, x64, arm64) of the Python interpreter.' description: "The target architecture (x86, x64) of the Python interpreter."
required: false required: false
allow-python-prereleases: allow-python-prereleases:
description: Allow prerelease versions of Python to be installed. description: "Allow prerelease versions of Python to be installed."
default: 'false' default: "false"
required: false required: false
token: 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: Used to pull python distributions from actions/python-versions. Since there's a default, this is typically not supplied by the user.
@ -23,45 +23,39 @@ inputs:
required: false required: false
prerelease: prerelease:
description: Allow prerelease versions to be installed description: Allow prerelease versions to be installed
default: 'false' default: "false"
required: false required: false
enable-pep582: enable-pep582:
description: Enable PEP 582 package loading globally. description: "Enable PEP 582 package loading globally."
default: 'false' default: "false"
required: false required: false
cache: cache:
description: Cache PDM installation. description: "Cache PDM installation."
default: 'false' default: "false"
required: false required: false
cache-dependency-path: cache-dependency-path:
description: The dependency file(s) to cache. description: "The dependency file(s) to cache."
default: pdm.lock default: "pdm.lock"
required: false
cache-restore-exact-match:
description: >
Restore cache ONLY on exact match with the primary key.
Note: Post-installation cache will still be saved if cache is 'true'.
default: 'false'
required: false required: false
update-python: update-python:
description: Whether to update the environment with the requested Python description: "Whether to update the environment with the requested Python"
default: 'true' default: "true"
outputs: outputs:
python-version: python-version:
description: The installed Python or PyPy version. Useful when given a version range as input. description: "The installed Python or PyPy version. Useful when given a version range as input."
python-path: python-path:
description: The absolute path to the Python or PyPy executable. description: "The absolute path to the Python or PyPy executable."
pdm-version: pdm-version:
description: The installed PDM version. description: "The installed PDM version."
pdm-bin: pdm-bin:
description: The absolute path to the PDM executable. description: "The absolute path to the PDM executable."
cache-hit: cache-hit:
description: Whether or not there was a cache hit. description: "Whether or not there was a cache hit."
runs: runs:
using: node20 using: "node16"
main: dist/setup-pdm.js main: "dist/setup-pdm.js"
post: dist/cache-save.js post: "dist/cache-save.js"
post-if: success() post-if: success()
branding: branding:
icon: code icon: "code"
color: green color: "green"

9
build.ts
View File

@ -1,9 +0,0 @@
import esbuild from 'esbuild'
esbuild.build({
platform: 'node',
target: 'node20',
bundle: true,
entryPoints: ['src/setup-pdm.ts', 'src/cache-save.ts'],
outdir: 'dist',
})

82180
dist/cache-save.js vendored
View File

File diff suppressed because one or more lines are too long

93597
dist/setup-pdm.js vendored
View File

File diff suppressed because one or more lines are too long

4
eslint.config.js
View File

@ -1,4 +0,0 @@
// eslint.config.js
const antfu = require('@antfu/eslint-config').default
module.exports = antfu()

31
package.json
View File

@ -1,34 +1,29 @@
{ {
"name": "setup-pdm", "name": "setup-pdm",
"version": "4.0.0", "version": "2.0.0",
"packageManager": "pnpm@8.14.3",
"description": "The GitHub Action for using pdm as the package manager", "description": "The GitHub Action for using pdm as the package manager",
"main": "dist/setup-pdm.js",
"scripts": {
"build": "esbuild src/setup-pdm.ts --bundle --platform=node --target=node16 --outfile=dist/setup-pdm.js && esbuild src/cache-save.ts --bundle --platform=node --target=node16 --outfile=dist/cache-save.js"
},
"packageManager": "pnpm@7.32.2",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://github.com/pdm-project/setup-pdm.git" "url": "git+https://github.com/pdm-project/setup-pdm.git"
}, },
"main": "dist/setup-pdm.js",
"scripts": {
"build": "esno build.ts",
"lint": "eslint .",
"lint:fix": "eslint . --fix"
},
"dependencies": { "dependencies": {
"@actions/cache": "^4.0.3", "@actions/cache": "^3.0.6",
"@actions/core": "^1.10.1", "@actions/core": "^1.10.0",
"@actions/exec": "^1.1.1", "@actions/exec": "^1.1.1",
"@actions/glob": "^0.4.0", "@actions/glob": "^0.3.0",
"got": "^14.0.0", "got": "^12.5.2",
"semver": "^7.5.4", "semver": "^7.3.8",
"setup-python": "actions/setup-python" "setup-python": "actions/setup-python"
}, },
"devDependencies": { "devDependencies": {
"@antfu/eslint-config": "^2.4.6",
"@types/node": "^18.11.0", "@types/node": "^18.11.0",
"@types/semver": "^7.5.4", "@types/semver": "^7.3.12",
"esbuild": "^0.19.12", "esbuild": "^0.15.11",
"eslint": "^8.56.0",
"esno": "^4.0.0",
"typescript": "^4.8.4" "typescript": "^4.8.4"
} }
} }

97
pdm.lock generated
View File

@ -1,70 +1,79 @@
# This file is @generated by PDM. # This file is @generated by PDM.
# It is not intended for manual editing. # It is not intended for manual editing.
[metadata]
groups = ["default", "dev"]
strategy = ["inherit_metadata"]
lock_version = "4.5.0"
content_hash = "sha256:c7bc8c77abe4c890545158d7bfdd811dce4a2658fa8ab856aa152f869973efab"
[[metadata.targets]]
requires_python = ">=3.9"
[[package]] [[package]]
name = "certifi" name = "certifi"
version = "2023.11.17" version = "2022.6.15"
requires_python = ">=3.6" requires_python = ">=3.6"
summary = "Python package for providing Mozilla's CA Bundle." summary = "Python package for providing Mozilla's CA Bundle."
groups = ["dev"]
marker = "python_version == \"3.9\"" [[package]]
files = [ name = "chardet"
{file = "certifi-2023.11.17-py3-none-any.whl", hash = "sha256:e036ab49d5b79556f99cfc2d9320b34cfbe5be05c5871b51de9329f0603b0474"}, version = "5.0.0"
{file = "certifi-2023.11.17.tar.gz", hash = "sha256:9b469f3a900bf28dc19b8cfbf8019bf47f7fdd1a65a1d4ffb98fc14166beb4d1"}, requires_python = ">=3.6"
] summary = "Universal encoding detector for Python 3"
[[package]]
name = "idna"
version = "3.3"
requires_python = ">=3.5"
summary = "Internationalized Domain Names in Applications (IDNA)"
[[package]] [[package]]
name = "pytz" name = "pytz"
version = "2023.3.post1" version = "2022.1"
summary = "World timezone definitions, modern and historical" summary = "World timezone definitions, modern and historical"
groups = ["dev"]
marker = "python_version == \"3.10\""
files = [
{file = "pytz-2023.3.post1-py2.py3-none-any.whl", hash = "sha256:ce42d816b81b68506614c11e8937d3aa9e41007ceb50bfdcb0749b921bf646c7"},
{file = "pytz-2023.3.post1.tar.gz", hash = "sha256:7b4fddbeb94a1eba4b557da24f19fdf9db575192544270a9101d8509f9f43d7b"},
]
[[package]] [[package]]
name = "setuptools" name = "setuptools"
version = "69.0.3" version = "68.0.0"
requires_python = ">=3.8" requires_python = ">=3.7"
summary = "Easily download, build, install, upgrade, and uninstall Python packages" summary = "Easily download, build, install, upgrade, and uninstall Python packages"
groups = ["dev"]
marker = "python_version == \"3.11\""
files = [
{file = "setuptools-69.0.3-py3-none-any.whl", hash = "sha256:385eb4edd9c9d5c17540511303e39a147ce2fc04bc55289c322b9e5904fe2c05"},
{file = "setuptools-69.0.3.tar.gz", hash = "sha256:be1af57fc409f93647f2e8e4573a142ed38724b8cdd389706a867bb4efcf1e78"},
]
[[package]] [[package]]
name = "six" name = "six"
version = "1.16.0" version = "1.16.0"
requires_python = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*" requires_python = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*"
summary = "Python 2 and 3 compatibility utilities" summary = "Python 2 and 3 compatibility utilities"
groups = ["dev"]
marker = "python_version == \"3.12\""
files = [
{file = "six-1.16.0-py2.py3-none-any.whl", hash = "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"},
{file = "six-1.16.0.tar.gz", hash = "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926"},
]
[[package]] [[package]]
name = "urllib3" name = "urllib3"
version = "2.1.0" version = "1.26.10"
requires_python = ">=3.8" requires_python = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, <4"
summary = "HTTP library with thread-safe connection pooling, file post, and more." summary = "HTTP library with thread-safe connection pooling, file post, and more."
groups = ["dev"]
marker = "python_version == \"3.13\"" [metadata]
files = [ lock_version = "4.2"
{file = "urllib3-2.1.0-py3-none-any.whl", hash = "sha256:55901e917a5896a349ff771be919f8bd99aff50b79fe58fec595eb37bbc56bb3"}, cross_platform = true
{file = "urllib3-2.1.0.tar.gz", hash = "sha256:df7aa8afb0148fa78488e7899b2c59b5f4ffcfa82e6c54ccb9dd37c1d7b52d54"}, groups = ["default", "dev"]
content_hash = "sha256:1c3bf31e6d80f6c468b7d8948c19a5eda9014342869911f0895691955e061357"
[metadata.files]
"certifi 2022.6.15" = [
{url = "https://files.pythonhosted.org/packages/cc/85/319a8a684e8ac6d87a1193090e06b6bbb302717496380e225ee10487c888/certifi-2022.6.15.tar.gz", hash = "sha256:84c85a9078b11105f04f3036a9482ae10e4621616db313fe045dd24743a0820d"},
{url = "https://files.pythonhosted.org/packages/e9/06/d3d367b7af6305b16f0d28ae2aaeb86154fa91f144f036c2d5002a5a202b/certifi-2022.6.15-py3-none-any.whl", hash = "sha256:fe86415d55e84719d75f8b69414f6438ac3547d2078ab91b67e779ef69378412"},
]
"chardet 5.0.0" = [
{url = "https://files.pythonhosted.org/packages/31/a2/12c090713b3d0e141f367236d3a8bdc3e5fca0d83ff3647af4892c16c205/chardet-5.0.0.tar.gz", hash = "sha256:0368df2bfd78b5fc20572bb4e9bb7fb53e2c094f60ae9993339e8671d0afb8aa"},
{url = "https://files.pythonhosted.org/packages/4c/d1/1b96dd69fa42f20b70701b5cd42a75dd5f0c7a24dc0abfef35cc146210dc/chardet-5.0.0-py3-none-any.whl", hash = "sha256:d3e64f022d254183001eccc5db4040520c0f23b1a3f33d6413e099eb7f126557"},
]
"idna 3.3" = [
{url = "https://files.pythonhosted.org/packages/04/a2/d918dcd22354d8958fe113e1a3630137e0fc8b44859ade3063982eacd2a4/idna-3.3-py3-none-any.whl", hash = "sha256:84d9dd047ffa80596e0f246e2eab0b391788b0503584e8945f2368256d2735ff"},
{url = "https://files.pythonhosted.org/packages/62/08/e3fc7c8161090f742f504f40b1bccbfc544d4a4e09eb774bf40aafce5436/idna-3.3.tar.gz", hash = "sha256:9d643ff0a55b762d5cdb124b8eaa99c66322e2157b69160bc32796e824360e6d"},
]
"pytz 2022.1" = [
{url = "https://files.pythonhosted.org/packages/2f/5f/a0f653311adff905bbcaa6d3dfaf97edcf4d26138393c6ccd37a484851fb/pytz-2022.1.tar.gz", hash = "sha256:1e760e2fe6a8163bc0b3d9a19c4f84342afa0a2affebfaa84b01b978a02ecaa7"},
{url = "https://files.pythonhosted.org/packages/60/2e/dec1cc18c51b8df33c7c4d0a321b084cf38e1733b98f9d15018880fb4970/pytz-2022.1-py2.py3-none-any.whl", hash = "sha256:e68985985296d9a66a881eb3193b0906246245294a881e7c8afe623866ac6a5c"},
]
"setuptools 68.0.0" = [
{url = "https://files.pythonhosted.org/packages/c7/42/be1c7bbdd83e1bfb160c94b9cafd8e25efc7400346cf7ccdbdb452c467fa/setuptools-68.0.0-py3-none-any.whl", hash = "sha256:11e52c67415a381d10d6b462ced9cfb97066179f0e871399e006c4ab101fc85f"},
{url = "https://files.pythonhosted.org/packages/dc/98/5f896af066c128669229ff1aa81553ac14cfb3e5e74b6b44594132b8540e/setuptools-68.0.0.tar.gz", hash = "sha256:baf1fdb41c6da4cd2eae722e135500da913332ab3f2f5c7d33af9b492acb5235"},
]
"six 1.16.0" = [
{url = "https://files.pythonhosted.org/packages/71/39/171f1c67cd00715f190ba0b100d606d440a28c93c7714febeca8b79af85e/six-1.16.0.tar.gz", hash = "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926"},
{url = "https://files.pythonhosted.org/packages/d9/5a/e7c31adbe875f2abbb91bd84cf2dc52d792b5a01506781dbcf25c91daf11/six-1.16.0-py2.py3-none-any.whl", hash = "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"},
]
"urllib3 1.26.10" = [
{url = "https://files.pythonhosted.org/packages/25/36/f056e5f1389004cf886bb7a8514077f24224238a7534497c014a6b9ac770/urllib3-1.26.10.tar.gz", hash = "sha256:879ba4d1e89654d9769ce13121e0f94310ea32e8d2f8cf587b77c08bbcdb30d6"},
{url = "https://files.pythonhosted.org/packages/68/47/93d3d28e97c7577f563903907912f4b3804054e4877a5ba6651f7182c53b/urllib3-1.26.10-py2.py3-none-any.whl", hash = "sha256:8298d6d56d39be0e3bc13c1c97d133f9b45d797169a0e11cdd0e0489d786f7ec"},
] ]

3881
pnpm-lock.yaml generated
View File

File diff suppressed because it is too large Load Diff

25
pyproject.toml
View File

@ -1,18 +1,29 @@
[project] [project]
name = "setup-pdm" authors = [
version = "0.0.0" {name = "Frost Ming", email = "mianghong@gmail.com"},
authors = [ { name = "Frost Ming", email = "mianghong@gmail.com" }, ] ]
requires-python = ">=3.9" include = "test.py"
license = { text = "MIT" } requires-python = ">=3.6"
dynamic = ["classifiers"]
license = {text = "MIT"}
[project.urls]
homepage = ""
[tool]
[tool.pdm] [tool.pdm]
distribution = false
[tool.pdm.dev-dependencies] [tool.pdm.dev-dependencies]
dev = [ dev = [
"idna; python_version=='3.6'",
"chardet; python_version=='3.7'",
"urllib3; python_version=='3.8'",
"certifi; python_version=='3.9'", "certifi; python_version=='3.9'",
"pytz; python_version=='3.10'", "pytz; python_version=='3.10'",
"setuptools; python_version=='3.11'", "setuptools; python_version=='3.11'",
"six; python_version=='3.12'", "six; python_version=='3.12'",
"urllib3; python_version=='3.13'",
] ]
[build-system]
requires = ["pdm-pep517"]
build-backend = "pdm.pep517.api"

59
src/cache-save.ts
View File

@ -1,48 +1,45 @@
import fs from 'node:fs' import * as core from '@actions/core';
import * as core from '@actions/core' import * as cache from '@actions/cache';
import * as cache from '@actions/cache' import fs from 'fs';
async function run() { async function run() {
try { try {
const cache = core.getBooleanInput('cache') const cache = core.getBooleanInput('cache');
if (cache) if (cache) {
await saveCache() await saveCache();
}
} catch (error) {
const err = error as Error;
core.setFailed(err.message);
} }
catch (error) {
const err = error as Error
core.setFailed(err.message)
}
// Explicit process.exit() to not wait for hanging promises,
// see https://github.com/actions/setup-node/issues/878
process.exit()
} }
async function saveCache() { async function saveCache() {
const cachePaths = JSON.parse(core.getState('cache-paths')) as string[] const cachePaths = JSON.parse(core.getState('cache-paths')) as string[];
core.debug(`paths for caching are ${cachePaths.join(', ')}`) core.debug(`paths for caching are ${cachePaths.join(', ')}`);
if (cachePaths.every(path => !fs.existsSync(path))) if (cachePaths.every((path) => !fs.existsSync(path))) {
throw new Error(`Cache folder path is retrieved for pdm but doesn't exist on disk: ${cachePaths.join(', ')}`) throw new Error(`Cache folder path is retrieved for pdm but doesn't exist on disk: ${cachePaths.join(', ')}`);
}
const primaryKey = core.getState('cache-primary-key') const primaryKey = core.getState('cache-primary-key');
const matchedKey = core.getState('cache-matched-key') const matchedKey = core.getState('cache-matched-key');
if (!primaryKey) { if (!primaryKey) {
core.warning('Error retrieving key from state.') core.warning('Error retrieving key from state.');
return return;
} } else if (matchedKey === primaryKey) {
else if (matchedKey === primaryKey) {
// no change in target directories // no change in target directories
core.info(`Cache hit occurred on the primary key ${primaryKey}, not saving cache.`) core.info(`Cache hit occurred on the primary key ${primaryKey}, not saving cache.`);
return return;
} }
const cacheId = await cache.saveCache(cachePaths, primaryKey) const cacheId = await cache.saveCache(cachePaths, primaryKey);
if (cacheId === -1) if (cacheId == -1) {
return return;
}
core.info(`Cache saved with the key: ${primaryKey}`) core.info(`Cache saved with the key: ${primaryKey}`);
} }
run() run();

69
src/caches.ts
View File

@ -1,63 +1,58 @@
import path from 'node:path' import path from 'path';
import process from 'node:process' import * as core from '@actions/core';
import * as core from '@actions/core' import * as cache from '@actions/cache';
import * as cache from '@actions/cache' import { getOutput } from './utils';
import { hashFiles } from '@actions/glob' import { hashFiles } from '@actions/glob';
import { getOutput } from './utils'
async function calculateCacheKeys(pythonVersion: string, cacheDependencyPath: string): Promise<{ primaryKey: string, restoreKeys: string[] }> { async function calculateCacheKeys(pythonVersion: string, cacheDependencyPath: string): Promise<{ primaryKey: string; restoreKeys: string[]; }> {
const hash = await hashFiles(cacheDependencyPath) const hash = await hashFiles(cacheDependencyPath);
const primaryKey = `setup-pdm-${process.env.RUNNER_OS}-${process.env.RUNNER_ARCH}-python-${pythonVersion}-${hash}` const primaryKey = `setup-pdm-${process.env['RUNNER_OS']}-python-${pythonVersion}-${hash}`;
const restoreKey = `setup-pdm-${process.env.RUNNER_OS}-${process.env.RUNNER_ARCH}-python-${pythonVersion}-` const restoreKey = `setup-pdm-${process.env['RUNNER_OS']}-python-${pythonVersion}-`;
return { primaryKey, restoreKeys: [restoreKey] };
const restoreExactMatch = core.getBooleanInput('cache-restore-exact-match')
if (restoreExactMatch) {
return { primaryKey, restoreKeys: [] }
}
return { primaryKey, restoreKeys: [restoreKey] }
} }
async function cacheDependencies(pdmBin: string, pythonVersion: string) { async function cacheDependencies(pdmBin: string, pythonVersion: string) {
const cacheDependencyPath = core.getInput('cache-dependency-path') || 'pdm.lock' const cacheDependencyPath = core.getInput('cache-dependency-path') || 'pdm.lock';
const { primaryKey, restoreKeys } = await calculateCacheKeys(pythonVersion, cacheDependencyPath) const { primaryKey, restoreKeys } = await calculateCacheKeys(pythonVersion, cacheDependencyPath);
if (primaryKey.endsWith('-')) { if (primaryKey.endsWith('-')) {
throw new Error( throw new Error(
`No file in ${process.cwd()} matched to [${cacheDependencyPath `No file in ${process.cwd()} matched to [${cacheDependencyPath
.split('\n') .split('\n')
.join(',')}], make sure you have checked out the target repository`, .join(',')}], make sure you have checked out the target repository`
) );
} }
const cachePath = await getCacheDirectories(pdmBin) const cachePath = await getCacheDirectories(pdmBin);
core.saveState('cache-paths', cachePath) core.saveState('cache-paths', cachePath);
core.saveState('cache-primary-key', primaryKey) core.saveState('cache-primary-key', primaryKey);
const matchedKey = await cache.restoreCache(cachePath, primaryKey, restoreKeys) const matchedKey = await cache.restoreCache(cachePath, primaryKey, restoreKeys);
handleMatchResult(matchedKey, primaryKey) handleMatchResult(matchedKey, primaryKey);
} }
async function getCacheDirectories(pdmBin: string): Promise<string[]> { async function getCacheDirectories(pdmBin: string): Promise<string[]> {
const paths = [ const paths = [
path.join(process.cwd(), '.venv'), path.join(process.cwd(), '.venv'),
path.join(process.cwd(), '__pypackages__'), path.join(process.cwd(), '__pypackages__'),
] ];
paths.push(await getOutput(pdmBin, ['config', 'cache_dir'])) paths.push(await getOutput(pdmBin, ["config", "cache_dir"]));
paths.push(await getOutput(pdmBin, ['config', 'venv.location'])) paths.push(await getOutput(pdmBin, ["config", "venv.location"]));
return paths return paths;
} }
function handleMatchResult(matchedKey: string | undefined, primaryKey: string) { function handleMatchResult(matchedKey: string | undefined, primaryKey: string) {
if (matchedKey) { if (matchedKey) {
core.saveState('cache-matched-key', matchedKey) core.saveState('cache-matched-key', matchedKey);
core.info(`Cache restored from key: ${matchedKey}`) core.info(`Cache restored from key: ${matchedKey}`);
} else {
core.info(`pdm cache is not found`);
} }
else { core.setOutput('cache-hit', matchedKey === primaryKey);
core.info(`pdm cache is not found`)
}
core.setOutput('cache-hit', matchedKey === primaryKey)
} }
export { cacheDependencies } export { cacheDependencies };

113
src/setup-pdm.ts
View File

@ -1,77 +1,72 @@
import * as os from 'node:os' import * as os from 'os';
import path from 'node:path' import path from 'path';
import { promises as fs } from 'node:fs' import * as core from '@actions/core';
import process from 'node:process' import { exec } from '@actions/exec';
import * as core from '@actions/core' import { promises as fs } from 'fs';
import { exec } from '@actions/exec' import { IS_WINDOWS } from 'setup-python/src/utils';
import { IS_WINDOWS } from 'setup-python/src/utils' import semParse from 'semver/functions/parse';
import semParse from 'semver/functions/parse' import * as utils from './utils';
import * as utils from './utils' import { cacheDependencies } from './caches';
import { cacheDependencies } from './caches'
const INSTALL_SCRIPT_URL = 'https://pdm.fming.dev/install-pdm.py' const INSTALL_SCRIPT_URL = 'https://pdm.fming.dev/install-pdm.py';
interface InstallOutput { interface InstallOutput {
pdm_version: string pdm_version: string;
pdm_bin: string pdm_bin: string;
install_python_version: string install_python_version: string;
install_location: string install_location: string;
} }
function getPep582Path(installDir: string, pythonVersion: string): string { function getPep582Path(installDir: string, pythonVersion: string): string {
const parsedVersion = semParse(pythonVersion)! const parsedVersion = semParse(pythonVersion)!;
if (IS_WINDOWS) if (IS_WINDOWS) {
return path.resolve(installDir, 'Lib/site-packages/pdm/pep582') return path.resolve(installDir, 'Lib/site-packages/pdm/pep582');
else } else {
return path.resolve(installDir, 'lib', `python${parsedVersion.major}.${parsedVersion.minor}`, 'site-packages/pdm/pep582') return path.resolve(installDir, 'lib', `python${parsedVersion.major}.${parsedVersion.minor}`, 'site-packages/pdm/pep582');
}
} }
async function run(): Promise<void> { async function run(): Promise<void> {
const arch = core.getInput('architecture') || os.arch() const arch = core.getInput('architecture') || os.arch();
const pdmVersion = core.getInput('version') const pdmVersion = core.getInput('version');
const pythonVersion = utils.resolveVersionInput()[0] || '3.x' const pythonVersion = core.getInput('python-version');
const updateEnvironment = core.getBooleanInput('update-python') const updateEnvironment = core.getBooleanInput('update-python');
const allowPythonPreReleases = core.getBooleanInput('allow-python-prereleases') const allowPythonPreReleases = core.getBooleanInput('allow-python-prereleases');
const cmdArgs = ['-'] const cmdArgs = ['-'];
if (core.getBooleanInput('prerelease')) if (core.getBooleanInput('prerelease')) {
cmdArgs.push('--prerelease') cmdArgs.push('--prerelease');
}
if (pdmVersion) if (pdmVersion) {
cmdArgs.push('--version', pdmVersion) cmdArgs.push('--version', pdmVersion);
}
cmdArgs.push('-o', 'install-output.json') cmdArgs.push('-o', 'install-output.json');
// Use the default python version installed with the runner // Use the default python version installed with the runner
try { try {
const installedPython = await utils.findPythonVersion(pythonVersion, arch, allowPythonPreReleases, updateEnvironment) await exec(IS_WINDOWS ? 'python' : 'python3', cmdArgs, { input: await utils.fetchUrlAsBuffer(INSTALL_SCRIPT_URL) });
const installOutput: InstallOutput = JSON.parse(await utils.readFile('install-output.json'));
core.debug(`Install output: ${installOutput}`);
core.setOutput('pdm-version', installOutput.pdm_version);
core.setOutput('pdm-bin', path.join(installOutput.install_location, installOutput.pdm_bin));
core.addPath(path.dirname(installOutput.pdm_bin));
if (core.getBooleanInput('enable-pep582')) {
core.exportVariable('PYTHONPATH', getPep582Path(installOutput.install_location, installOutput.install_python_version));
}
const installedPython = await utils.findPythonVersion(pythonVersion, arch, allowPythonPreReleases, updateEnvironment);
if (process.platform === 'linux') { if (process.platform === 'linux') {
// See https://github.com/actions/virtual-environments/issues/2803 // See https://github.com/actions/virtual-environments/issues/2803
if (process.arch === 'x64') { core.exportVariable('LD_PRELOAD', '/lib/x86_64-linux-gnu/libgcc_s.so.1');
core.exportVariable('LD_PRELOAD', '/lib/x86_64-linux-gnu/libgcc_s.so.1') }
} core.info(`Successfully setup ${installOutput.pdm_version} with Python ${installedPython}`);
else if (process.arch === 'arm64') { const matchersPath = path.join(__dirname, '..', '.github');
core.exportVariable('LD_PRELOAD', '/lib/aarch64-linux-gnu/libgcc_s.so.1') core.info(`##[add-matcher]${path.join(matchersPath, 'python.json')}`);
} if (utils.isCacheAvailable()) {
await cacheDependencies(installOutput.pdm_bin, installedPython);
} }
await exec(IS_WINDOWS ? 'python' : 'python3', cmdArgs, { input: await utils.fetchUrlAsBuffer(INSTALL_SCRIPT_URL) })
const installOutput: InstallOutput = JSON.parse(await utils.readFile('install-output.json'))
core.debug(`Install output: ${installOutput}`)
core.info(`Successfully setup ${installOutput.pdm_version} with Python ${installedPython}`)
core.setOutput('pdm-version', installOutput.pdm_version)
core.setOutput('pdm-bin', path.join(installOutput.install_location, installOutput.pdm_bin))
core.addPath(path.dirname(installOutput.pdm_bin))
if (core.getBooleanInput('enable-pep582'))
core.exportVariable('PYTHONPATH', getPep582Path(installOutput.install_location, installOutput.install_python_version))
const matchersPath = path.join(__dirname, '..', '.github')
core.info(`##[add-matcher]${path.join(matchersPath, 'python.json')}`)
if (utils.isCacheAvailable())
await cacheDependencies(installOutput.pdm_bin, installedPython)
await fs.rm('install-output.json') await fs.rm('install-output.json')
} } catch (error: any) {
catch (error: any) { core.setFailed(error.message);
core.setFailed(error.message)
} }
} }
run() run();

130
src/utils.ts
View File

@ -1,123 +1,75 @@
import fs from 'node:fs' import * as core from '@actions/core';
import { Buffer } from 'node:buffer' import * as cache from '@actions/cache';
import * as core from '@actions/core' import got from 'got';
import * as cache from '@actions/cache' import { promises as fs } from 'fs';
import got from 'got' import { useCpythonVersion } from 'setup-python/src/find-python';
import { useCpythonVersion } from 'setup-python/src/find-python' import { findPyPyVersion } from 'setup-python/src/find-pypy';
import { findPyPyVersion } from 'setup-python/src/find-pypy' import { getExecOutput } from '@actions/exec';
import {
getVersionInputFromFile,
getVersionInputFromTomlFile,
logWarning,
} from 'setup-python/src/utils'
import { getExecOutput } from '@actions/exec'
function isPyPyVersion(versionSpec: string): boolean { function isPyPyVersion(versionSpec: string): boolean {
return versionSpec.startsWith('pypy') return versionSpec.startsWith('pypy');
} }
export async function fetchUrlAsBuffer(url: string): Promise<Buffer> { export async function fetchUrlAsBuffer(url: string): Promise<Buffer> {
const response = await got(url) const response = await got(url);
if (!response.ok) if (!response.ok) {
throw new Error(`Failed to fetch ${url}`) throw new Error(`Failed to fetch ${url}`);
}
return Buffer.from(response.body) return Buffer.from(response.body);
} }
export async function findPythonVersion(version: string, architecture: string, allowPreReleases: boolean, updateEnvironment: boolean = true): Promise<string> { export async function findPythonVersion(version: string, architecture: string, allowPreReleases: boolean, updateEnvironment: boolean = true): Promise<string> {
let pythonVersion = '' let pythonVersion = '';
if (isPyPyVersion(version)) { if (isPyPyVersion(version)) {
const installed = await findPyPyVersion( const installed = await findPyPyVersion(
version, version,
architecture, architecture,
updateEnvironment, updateEnvironment,
false, false,
allowPreReleases, allowPreReleases
) );
pythonVersion = `${installed.resolvedPyPyVersion}-${installed.resolvedPythonVersion}` pythonVersion = `${installed.resolvedPyPyVersion}-${installed.resolvedPythonVersion}`;
core.info( core.info(
`Successfully set up PyPy ${installed.resolvedPyPyVersion} with Python (${installed.resolvedPythonVersion})`, `Successfully set up PyPy ${installed.resolvedPyPyVersion} with Python (${installed.resolvedPythonVersion})`
) );
return `pypy-${installed.resolvedPythonVersion}` return `pypy-${installed.resolvedPythonVersion}`;
} } else {
else {
const installed = await useCpythonVersion( const installed = await useCpythonVersion(
version, version,
architecture, architecture,
updateEnvironment, updateEnvironment,
false, false,
allowPreReleases, allowPreReleases
) );
pythonVersion = installed.version pythonVersion = installed.version;
core.info(`Successfully set up ${installed.impl} (${pythonVersion})`) core.info(`Successfully set up ${installed.impl} (${pythonVersion})`);
return installed.version return installed.version;
} }
} }
export async function readFile(filePath: string): Promise<string> { export async function readFile(filePath: string): Promise<string> {
return await fs.promises.readFile(filePath, 'utf8') return await fs.readFile(filePath, 'utf8');
} }
export async function getOutput(command: string, args: string[]): Promise<string> { export async function getOutput(command: string, args: string[]): Promise<string> {
const { stdout, exitCode, stderr } = await getExecOutput(command, args) const { stdout, exitCode, stderr } = await getExecOutput(command, args);
if (exitCode && stderr) if (exitCode && stderr) {
throw new Error(`Could not run ${command} ${args.join(' ')}: ${stderr}`) throw new Error(`Could not run ${command} ${args.join(' ')}: ${stderr}`);
}
return stdout.trim() return stdout.trim();
} }
export function isCacheAvailable(): boolean { export function isCacheAvailable(): boolean {
if (!core.getBooleanInput('cache')) if (!core.getBooleanInput('cache')) {
return false return false;
}
if (!cache.isFeatureAvailable()) { if (!cache.isFeatureAvailable()) {
core.warning('Caching is not supported on this platform.') core.warning('Caching is not supported on this platform.');
return false return false;
} }
return true return true;
}
function resolveVersionInputFromDefaultFile(): string[] {
const couples: [string, (versionFile: string) => string[]][] = [
['pyproject.toml', getVersionInputFromTomlFile],
]
for (const [versionFile, _fn] of couples) {
logWarning(
`Neither 'python-version' nor 'python-version-file' inputs were supplied. Attempting to find '${versionFile}' file.`,
)
if (fs.existsSync(versionFile))
return _fn(versionFile)
else
logWarning(`${versionFile} doesn't exist.`)
}
return []
}
export function resolveVersionInput() {
let versions = core.getMultilineInput('python-version')
const versionFile = core.getInput('python-version-file')
if (versions.length) {
if (versionFile) {
core.warning(
'Both python-version and python-version-file inputs are specified, only python-version will be used.',
)
}
}
else {
if (versionFile) {
if (!fs.existsSync(versionFile)) {
throw new Error(
`The specified python version file at: ${versionFile} doesn't exist.`,
)
}
versions = getVersionInputFromFile(versionFile)
}
else {
versions = resolveVersionInputFromDefaultFile()
}
}
return versions
} }

7
test.py
View File

@ -1,14 +1,17 @@
import importlib
import os import os
import sys import sys
import unittest import unittest
import importlib
PACKAGE_MAP = { PACKAGE_MAP = {
"3.6": "idna",
"3.7": "chardet",
"3.8": "urllib3",
"3.9": "certifi", "3.9": "certifi",
"3.10": "pytz", "3.10": "pytz",
"3.11": "setuptools", "3.11": "setuptools",
"3.12": "six", "3.12": "six",
"3.13": "urllib3",
} }

20
tsconfig.json
View File

@ -2,9 +2,17 @@
"compilerOptions": { "compilerOptions": {
/* Basic Options */ /* Basic Options */
// "incremental": true, /* Enable incremental compilation */ // "incremental": true, /* Enable incremental compilation */
"target": "ESNext" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */, "target": "es6" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
"module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
// "allowJs": true /* Allow javascript files to be compiled. */,
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
// "declaration": true, /* Generates corresponding '.d.ts' file. */
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
"outDir": "./lib" /* Redirect output structure to the directory. */,
"rootDir": "./src" /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */, "rootDir": "./src" /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */,
"module": "CommonJS" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
// "composite": true, /* Enable project compilation */ // "composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
// "removeComments": true, /* Do not emit comments to output. */ // "removeComments": true, /* Do not emit comments to output. */
@ -15,14 +23,6 @@
/* Strict Type-Checking Options */ /* Strict Type-Checking Options */
"strict": true /* Enable all strict type-checking options. */, "strict": true /* Enable all strict type-checking options. */,
// "allowJs": true /* Allow javascript files to be compiled. */,
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
// "declaration": true, /* Generates corresponding '.d.ts' file. */
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
"outDir": "./lib" /* Redirect output structure to the directory. */,
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */ // "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */ // "strictFunctionTypes": true, /* Enable strict checking of function types. */