A GitHub Action that installs pdm properly for all Python versions

Nowadays the main reason to use this action is that actions/setup-python doesn't support caching for PDM out of the box while setup-pdm does.

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.

Include the action in your workflow yaml:

steps:
  - uses: actions/checkout@v4
  - name: Setup PDM
    uses: pdm-project/setup-pdm@v4
    # You are now able to use PDM in your workflow
  - name: Install dependencies
    run: pdm install

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

This action supports the following inputs:

This action also exposes the following outputs:

This action has a built-in cache support. You can use it like this:

- uses: pdm-project/setup-pdm@v3
  with:
    python-version: 3.9
    cache: true

The default path to calculate the cache key is ./pdm.lock, you can change it by setting the cache-dependency-path input.

Using a list of file paths to cache dependencies

- uses: pdm-project/setup-pdm@v3
  with:
    python-version: 3.9
    cache: true
    cache-dependency-path: |
      ./pdm.lock
      ./pdm.new.lock

Using a glob pattern to cache dependencies

- uses: pdm-project/setup-pdm@v3
  with:
    python-version: 3.9
    cache: true
    cache-dependency-path: '**/pdm.lock'