Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
code

GitHub Action

Setup PDM

v2.7

Setup PDM

code

Setup PDM

Set up a specific version of PDM and uses a given Python version to work on

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Setup PDM

              
  uses: pdm-project/setup-pdm@v2.7
Learn more about this action in pdm-project/setup-pdm

Choose a version

Setup PDM for GitHub Action

A GitHub Action that installs pdm properly for all Python versions

Why do I need this action?

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!

Usage

Include the action in your workflow yaml file with the following arguments:

steps:
    ...
    - uses: pdm-project/setup-pdm@main
      name: Setup PDM
      with:
        python-version: 3.8  # Version range or exact version of a Python version to use, the same as actions/setup-python
        architecture: x64    # The target architecture (x86, x64) of the Python interpreter. the same as actions/setup-python
        version: 1.4.0       # The version of PDM to install. Leave it as empty to use the latest version from PyPI
        prerelease: true     # Allow prerelease versions to be installed
        enable-pep582: true  # Enable PEP 582 package loading globally
    - name: Install dependencies
      run: pdm install       # Then you can use pdm in the following steps.
    ...

You don't need actions/setup-python actually.