Skip to content

Clarify that mix do early-exits on error #14134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 31, 2024
Merged

Clarify that mix do early-exits on error #14134

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b8d142
Clarify that `mix do` early-exits on error
s3cur3 Dec 31, 2024
420956e
Update lib/mix/lib/mix/tasks/do.ex
josevalim Dec 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion lib/mix/lib/mix/tasks/do.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ defmodule Mix.Tasks.Do do
@shortdoc "Executes the tasks separated by plus"

@moduledoc """
Executes the tasks separated by `+`:
Executes the tasks separated by `+`, aborting if any task errors.

Here is an example:

$ mix do compile --list + deps

Expand Down Expand Up @@ -41,6 +43,16 @@ defmodule Mix.Tasks.Do do
Since then, the `+` operator has been introduced as a
separator for better support on Windows terminals.

## Error handling

If any task in the list of tasks exits with an error,
no subsequent tasks will be run. For instance:

$ mix do compile + test

If the compilation step fails, the tests will not be
attempted.

## Command line options

* `--app` - limit recursive tasks to the given apps.
Expand Down