Skip to content

Commit 327261f

Browse files
authored
doc: Update 'Why do I need this action?' section of README (#49)
* Update 'Why do I need this action?' section of README * Update README.md
1 parent c050bdc commit 327261f

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,17 @@ A GitHub Action that installs pdm properly for all Python versions
44

55
## Why do I need this action?
66

7-
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!
8-
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!
7+
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.
8+
9+
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.
910

1011
## Usage
1112

1213
Include the action in your workflow yaml:
1314

1415
```yaml
1516
steps:
16-
- uses: actions/checkout@v3
17+
- uses: actions/checkout@v4
1718
- name: Setup PDM
1819
uses: pdm-project/setup-pdm@v4
1920
# You are now able to use PDM in your workflow

0 commit comments

Comments
 (0)