Skip to content

Create the task.dir before evaluating ShVars. #2813

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

Open
trulede wants to merge 1 commit into
base: main
Choose a base branch
from
+54 −4
Open

Create the task.dir before evaluating ShVars. #2813

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 12 additions & 4 deletions task.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,14 @@ func (e *Executor) RunTask(ctx context.Context, call *Call) error {
}
}

// Attempt to create the task dir before compiling the task so that ShVars can run/access
// the configured task dir. If the directory can't be created (e.g. contains unresolved
// template values), continue as if nothing happened (the directory is created again later).
if t.Dir != "" && !strings.Contains(t.Dir, "{") {

@vmaerten vmaerten Aug 10, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it does not work and this cause the extra dir created.

Maybe we can use something like :

func dirDependsOnShVar(rawDir string, vars *ast.Vars) bool {
    if !strings.Contains(rawDir, "{{") {
        return false
    }
    for name, v := range vars.All() {
        if v.Sh != nil && strings.Contains(rawDir, name) {
            return true
        }
    }
    return false
}
Suggested change
if t.Dir != "" && !strings.Contains(t.Dir, "{") {
if t.Dir != "" && !dirDependsOnShVar(origTask.Dir, t.Vars) {

if err := e.mkdir(t); err != nil {
e.Logger.Warnf("task: cannot make directory %q: %v\n", t.Dir, err)
}
}
t, err = e.CompiledTask(call)
if err != nil {
return err
Expand Down Expand Up @@ -205,6 +213,10 @@ func (e *Executor) RunTask(ctx context.Context, call *Call) error {
defer release()

if err = e.startExecution(ctx, t, func(ctx context.Context) error {
if err := e.mkdir(t); err != nil {
e.Logger.Errf(logger.Red, "task: cannot make directory %q: %v\n", t.Dir, err)
}

e.Logger.VerboseErrf(logger.Magenta, "task: %q started\n", call.Task)
if err := e.runDeps(ctx, t); err != nil {
return err
Expand Down Expand Up @@ -260,10 +272,6 @@ func (e *Executor) RunTask(ctx context.Context, call *Call) error {
}
}

if err := e.mkdir(t); err != nil {
e.Logger.Errf(logger.Red, "task: cannot make directory %q: %v\n", t.Dir, err)
}

var deferredExitCode uint8

for i := range t.Cmds {
Expand Down
31 changes: 31 additions & 0 deletions task_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1752,6 +1752,37 @@ func TestDynamicVariablesShouldRunOnTheTaskDir(t *testing.T) {
})
}

func TestDynamicVariablesRunOnParentDir(t *testing.T) {
t.Parallel()

const expected = "fubar"
const dir = "testdata/dir/dynamic_var_on_parent_dir/"
const toBeCreated = dir + "somefolder"
const target = "default"
var out bytes.Buffer
e := task.NewExecutor(
task.WithDir(dir),
task.WithStdout(&out),
task.WithStderr(&out),
task.WithSilent(true),
)

// Ensure that the directory to be created doesn't actually exist.
_ = os.RemoveAll(toBeCreated)
if _, err := os.Stat(toBeCreated); err == nil {
t.Errorf("Directory should not exist: %v", err)
}
require.NoError(t, e.Setup())
require.NoError(t, e.Run(t.Context(), &task.Call{Task: target}))

normalized := normalizePathSeparators(out.String())
got := strings.TrimSuffix(filepath.Base(normalized), "\n")
assert.Equal(t, expected, got, "Mismatch message from parent dir")

// Clean-up after ourselves only if no error.
_ = os.RemoveAll(toBeCreated)
}

func TestDisplaysErrorOnVersion1Schema(t *testing.T) {
t.Parallel()

Expand Down
10 changes: 10 additions & 0 deletions testdata/dir/dynamic_var_on_parent_dir/Taskfile.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
version: '3'

tasks:
default:
dir: somefolder
cmds:
- echo {{.MSG}}
vars:
MSG:
sh: cat ../foo.txt
1 change: 1 addition & 0 deletions testdata/dir/dynamic_var_on_parent_dir/foo.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
fubar
Loading