tektoncd · tekton-robot · Dec 14, 2023 · Dec 6, 2023
diff --git a/docs/pipeline-api.md b/docs/pipeline-api.md
@@ -6720,6 +6720,21 @@ string
 </tr>
 <tr>
 <td>
+<code>workingDir</code><br/>
+<em>
+string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Step&rsquo;s working directory.
+If not specified, the container runtime&rsquo;s default will be used, which
+might be configured in the container image.
+Cannot be updated.</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>params</code><br/>
 <em>
 <a href="#tekton.dev/v1.ParamSpecs">
@@ -7541,6 +7556,21 @@ string
 </tr>
 <tr>
 <td>
+<code>workingDir</code><br/>
+<em>
+string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Step&rsquo;s working directory.
+If not specified, the container runtime&rsquo;s default will be used, which
+might be configured in the container image.
+Cannot be updated.</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>params</code><br/>
 <em>
 <a href="#tekton.dev/v1.ParamSpecs">

diff --git a/docs/stepactions.md b/docs/stepactions.md
@@ -13,6 +13,7 @@ weight: 201
  - [Passing Params to StepAction](#passing-params-to-stepaction)
  - [Emitting Results](#emitting-results)
  - [Fetching Emitted Results from StepActions](#fetching-emitted-results-from-stepactions)
+ - [Declaring WorkingDir](#declaring-workingdir)
  - [Declaring SecurityContext](#declaring-securitycontext)
  - [Declaring VolumeMounts](#declaring-volumemounts)
  - [Referencing a StepAction](#referencing-a-stepaction)
@@ -51,6 +52,7 @@ A `StepAction` definition supports the following fields:
  - `env`
  - [`params`](#declaring-parameters)
  - [`results`](#emitting-results)
+ - [`workingDir`](#declaring-workingdir)
  - [`securityContext`](#declaring-securitycontext)
  - [`volumeMounts`](#declaring-volumemounts)
 
@@ -234,6 +236,40 @@ spec:
  name: kaniko-step-action
 ```
 
+### Declaring WorkingDir
+
+You can declare `workingDir` in a `StepAction`:
+
+```yaml
+apiVersion: tekton.dev/v1alpha1
+kind: StepAction
+metadata:
+ name: example-stepaction-name
+spec:
+ image: gcr.io/tekton-releases/github.com/tektoncd/pipeline/cmd/git-init:latest
+ workingDir: /workspace
+ script: |
+ # clone the repo
+ ...
+```
+
+The `Task` using the `StepAction` has more context about how the `Steps` have been orchestrated. As such, the `Task` should be able to update the `workingDir` of the `StepAction` so that the `StepAction` is executed from the correct location.
+The `StepAction` can parametrize the `workingDir` and work relative to it. This way, the `Task` does not really need control over the workingDir, it just needs to pass the path as a parameter. 
+
+```yaml
+apiVersion: tekton.dev/v1alpha1
+kind: StepAction
+metadata:
+ name: example-stepaction-name
+spec:
+ image: ubuntu
+ params:
+ - name: source
+ description: "The path to the source code."
+ workingDir: $(params.source)
+```
+
+
 ### Declaring SecurityContext
 
 You can declare `securityContext` in a `StepAction`:

diff --git a/pkg/apis/pipeline/v1/task_validation.go b/pkg/apis/pipeline/v1/task_validation.go
@@ -352,6 +352,12 @@ func validateStep(ctx context.Context, s Step, names sets.String) (errs *apis.Fi
  Paths: []string{"script"},
  })
  }
+ if s.WorkingDir != "" {
+ errs = errs.Also(&apis.FieldError{
+ Message: "working dir cannot be used with Ref",
+ Paths: []string{"workingDir"},
+ })
+ }
  if s.Env != nil {
  errs = errs.Also(&apis.FieldError{
  Message: "env cannot be used with Ref",

diff --git a/pkg/apis/pipeline/v1/task_validation_test.go b/pkg/apis/pipeline/v1/task_validation_test.go
@@ -528,8 +528,7 @@ func TestTaskSpecStepActionReferenceValidate(t *testing.T) {
  }{{
  name: "valid stepaction ref",
  Steps: []v1.Step{{
- Name: "mystep",
- WorkingDir: "/foo",
+ Name: "mystep",
  Ref: &v1.Ref{
  Name: "stepAction",
  },
@@ -1536,6 +1535,18 @@ func TestTaskSpecValidateErrorWithStepActionRef(t *testing.T) {
  Message: "script cannot be used with Ref",
  Paths: []string{"steps[0].script"},
  },
+ }, {
+ name: "Cannot use workingDir with Ref",
+ Steps: []v1.Step{{
+ Ref: &v1.Ref{
+ Name: "stepAction",
+ },
+ WorkingDir: "/workspace",
+ }},
+ expectedError: apis.FieldError{
+ Message: "working dir cannot be used with Ref",
+ Paths: []string{"steps[0].workingDir"},
+ },
  }, {
  name: "Cannot use env with Ref",
  Steps: []v1.Step{{

diff --git a/pkg/apis/pipeline/v1alpha1/openapi_generated.go b/pkg/apis/pipeline/v1alpha1/openapi_generated.go
diff --git a/pkg/apis/pipeline/v1alpha1/stepaction_types.go b/pkg/apis/pipeline/v1alpha1/stepaction_types.go
@@ -112,6 +112,12 @@ type StepActionSpec struct {
  // If Script is not empty, the Step cannot have an Command and the Args will be passed to the Script.
  // +optional
  Script string `json:"script,omitempty"`
+ // Step's working directory.
+ // If not specified, the container runtime's default will be used, which
+ // might be configured in the container image.
+ // Cannot be updated.
+ // +optional
+ WorkingDir string `json:"workingDir,omitempty" protobuf:"bytes,5,opt,name=workingDir"`
  // Params is a list of input parameters required to run the stepAction.
  // Params must be supplied as inputs in Steps unless they declare a defaultvalue.
  // +optional

diff --git a/pkg/apis/pipeline/v1alpha1/swagger.json b/pkg/apis/pipeline/v1alpha1/swagger.json
@@ -457,6 +457,10 @@
  "x-kubernetes-list-type": "atomic",
  "x-kubernetes-patch-merge-key": "mountPath",
  "x-kubernetes-patch-strategy": "merge"
+ },
+ "workingDir": {
+ "description": "Step's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.",
+ "type": "string"
  }
  }
  },

diff --git a/pkg/apis/pipeline/v1beta1/task_validation.go b/pkg/apis/pipeline/v1beta1/task_validation.go
@@ -341,6 +341,12 @@ func validateStep(ctx context.Context, s Step, names sets.String) (errs *apis.Fi
  Paths: []string{"script"},
  })
  }
+ if s.WorkingDir != "" {
+ errs = errs.Also(&apis.FieldError{
+ Message: "working dir cannot be used with Ref",
+ Paths: []string{"workingDir"},
+ })
+ }
  if s.Env != nil {
  errs = errs.Also(&apis.FieldError{
  Message: "env cannot be used with Ref",

diff --git a/pkg/apis/pipeline/v1beta1/task_validation_test.go b/pkg/apis/pipeline/v1beta1/task_validation_test.go
@@ -532,8 +532,7 @@ func TestTaskSpecStepActionReferenceValidate(t *testing.T) {
  }{{
  name: "valid stepaction ref",
  Steps: []v1beta1.Step{{
- Name: "mystep",
- WorkingDir: "/foo",
+ Name: "mystep",
  Ref: &v1beta1.Ref{
  Name: "stepAction",
  },
@@ -1549,6 +1548,18 @@ func TestTaskSpecValidateErrorWithStepActionRef(t *testing.T) {
  Message: "script cannot be used with Ref",
  Paths: []string{"steps[0].script"},
  },
+ }, {
+ name: "Cannot use workingDir with Ref",
+ Steps: []v1beta1.Step{{
+ Ref: &v1beta1.Ref{
+ Name: "stepAction",
+ },
+ WorkingDir: "/workspace",
+ }},
+ expectedError: apis.FieldError{
+ Message: "working dir cannot be used with Ref",
+ Paths: []string{"steps[0].workingDir"},
+ },
  }, {
  name: "Cannot use env with Ref",
  Steps: []v1beta1.Step{{

diff --git a/pkg/reconciler/taskrun/resources/taskspec.go b/pkg/reconciler/taskrun/resources/taskspec.go
@@ -125,6 +125,7 @@ func GetStepActionsData(ctx context.Context, taskSpec v1.TaskSpec, taskRun *v1.T
  if stepActionSpec.Script != "" {
  s.Script = stepActionSpec.Script
  }
+ s.WorkingDir = stepActionSpec.WorkingDir
  if stepActionSpec.Env != nil {
  s.Env = stepActionSpec.Env
  }

diff --git a/pkg/reconciler/taskrun/resources/taskspec_test.go b/pkg/reconciler/taskrun/resources/taskspec_test.go
@@ -321,8 +321,7 @@ func TestGetStepActionsData(t *testing.T) {
  Ref: &v1.Ref{
  Name: "stepAction",
  },
- WorkingDir: "/bar",
- Timeout: &metav1.Duration{Duration: time.Hour},
+ Timeout: &metav1.Duration{Duration: time.Hour},
  }},
  },
  },
@@ -343,11 +342,10 @@ func TestGetStepActionsData(t *testing.T) {
  },
  },
  want: []v1.Step{{
- Image: "myimage",
- Command: []string{"ls"},
- Args: []string{"-lh"},
- WorkingDir: "/bar",
- Timeout: &metav1.Duration{Duration: time.Hour},
+ Image: "myimage",
+ Command: []string{"ls"},
+ Args: []string{"-lh"},
+ Timeout: &metav1.Duration{Duration: time.Hour},
  VolumeMounts: []corev1.VolumeMount{{
  Name: "$(params.foo)",
  MountPath: "/path",
@@ -469,8 +467,7 @@ func TestGetStepActionsData(t *testing.T) {
  Ref: &v1.Ref{
  Name: "stepAction",
  },
- WorkingDir: "/bar",
- Timeout: &metav1.Duration{Duration: time.Hour},
+ Timeout: &metav1.Duration{Duration: time.Hour},
  }, {
  Image: "foo",
  Command: []string{"ls"},
@@ -490,11 +487,10 @@ func TestGetStepActionsData(t *testing.T) {
  },
  },
  want: []v1.Step{{
- Image: "myimage",
- Command: []string{"ls"},
- Args: []string{"-lh"},
- WorkingDir: "/bar",
- Timeout: &metav1.Duration{Duration: time.Hour},
+ Image: "myimage",
+ Command: []string{"ls"},
+ Args: []string{"-lh"},
+ Timeout: &metav1.Duration{Duration: time.Hour},
  }, {
  Image: "foo",
  Command: []string{"ls"},

diff --git a/pkg/reconciler/taskrun/taskrun_test.go b/pkg/reconciler/taskrun/taskrun_test.go
@@ -2942,7 +2942,6 @@ spec:
  - ref:
  name: stepAction
  name: step1
- workingDir: /foo
  - ref:
  name: stepAction2
  name: step2
@@ -2993,7 +2992,6 @@ spec:
  Image: "myImage",
  Command: []string{"ls"},
  Name: "step1",
- WorkingDir: "/foo",
  SecurityContext: &corev1.SecurityContext{Privileged: &securityContextPrivileged},
  }, {
  Image: "myImage",