Feature: composite scripts

[noirbizarre]

Pull Request Check List

• A news fragment is added in news/ describing what is new.
• Test cases added for changed code.

Describe what you have changed in this PR.

This PR adds a "composite script" feature allowing to run multiple scripts one by one.

A classical use case would be:

[tool.pdm.scripts]
lint = "flake8 mypackage"
test = "pytest -v tests/"
ci = {composite = ["lint", "test"]}

Then pdm run ci will run the lint command and then the test command. Execution stops and returns on first error.

Both env and env_file defined in composite action will override those defined in called tasks.

So with the following:

[tool.pdm.scripts]
echo = {shell = "echo $VAR", env = { VAR = "value"}}
composite = {composite = ["echo"], env = { VAR = "overriden"}}

you will have:

$ pdm run echo
value
$ pdm run composite
overriden

[frostming]

Hi, this feature is good to have, but since there is still room for improvement and we are developing on v2.0, new features should go there. I will change the base to dev branch if you don't mind.

[noirbizarre]

Given it's now planned for 2.0 and we have time to craft a proper solution, I did the following:

• rebased on dev branch
• merged run() and _run_subtask()
• make run() and _run_task() accept an optional TaskOptions parameter
• environment variables are cascading

I think I'm going to add:

• support for passing argument to subtasks
• more tests on environment handling (at least for cascading)

[noirbizarre]

PR updated with:

• more tests
• arguments passing to subtasks

I would say scope is OK for a first unless you want or see something else.

Note: previous build failure was a permission denied on github assets under Windows, I don't think this is related to this PR

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 94.73684% with 1 line in your changes missing coverage. Please review.

Project coverage is 84.34%. Comparing base (b8878b1) to head (37bb6d4).

Files with missing lines	Patch %	Lines
pdm/cli/commands/run.py	94.73%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##              dev    #1117   +/-   ##
=======================================
  Coverage   84.33%   84.34%           
=======================================
  Files          79       79           
  Lines        6921     6930    +9     
  Branches     1640     1644    +4     
=======================================
+ Hits         5837     5845    +8     
+ Misses        736      732    -4     
- Partials      348      353    +5     

Flag	Coverage Δ
unittests	84.11% <94.73%> (+<0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[frostming]

Nice work! LGTM