TEP-0097 breakpoint before steps for taskrun #7391

chengjoey · 2023-11-18T05:21:28Z

Changes

breakpoint before steps for taskrun
TEP-0097
#5691

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
Has Tests included if any functionality added or changed
Follows the commit message standard
Meets the Tekton contributor standards (including functionality, content, code)
Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings). See some examples of good release notes.
Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

breakpoint before a step

chengjoey · 2023-11-18T05:21:37Z

/kind feature

chengjoey · 2023-11-18T05:23:12Z

/assign @chitrangpatel @lbernick

tekton-robot · 2023-11-18T05:27:47Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/main.go	11.6%	12.7%	1.1
pkg/apis/pipeline/v1/taskrun_types.go	81.4%	82.8%	1.5
pkg/apis/pipeline/v1/taskrun_validation.go	96.9%	97.1%	0.1
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	93.3%	93.5%	0.2
pkg/apis/pipeline/v1beta1/taskrun_types.go	82.3%	83.6%	1.3
pkg/apis/pipeline/v1beta1/taskrun_validation.go	97.0%	97.1%	0.1
pkg/entrypoint/entrypointer.go	87.6%	87.7%	0.1
pkg/pod/entrypoint.go	93.4%	93.5%	0.1
pkg/pod/script.go	99.0%	99.1%	0.1

tekton-robot · 2023-11-18T05:45:41Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/main.go	11.6%	12.7%	1.1
pkg/apis/pipeline/v1/taskrun_types.go	81.4%	82.8%	1.5
pkg/apis/pipeline/v1/taskrun_validation.go	96.9%	97.1%	0.1
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	93.3%	93.5%	0.2
pkg/apis/pipeline/v1beta1/taskrun_types.go	82.3%	83.6%	1.3
pkg/apis/pipeline/v1beta1/taskrun_validation.go	97.0%	97.1%	0.1
pkg/entrypoint/entrypointer.go	87.6%	87.7%	0.1
pkg/pod/entrypoint.go	93.4%	93.5%	0.1
pkg/pod/script.go	99.0%	99.1%	0.1

tekton-robot · 2023-11-18T13:55:12Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/main.go	11.6%	12.7%	1.1
pkg/apis/pipeline/v1/taskrun_types.go	81.4%	82.8%	1.5
pkg/apis/pipeline/v1/taskrun_validation.go	96.9%	97.1%	0.1
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	93.3%	93.5%	0.2
pkg/apis/pipeline/v1beta1/taskrun_types.go	82.3%	83.6%	1.3
pkg/apis/pipeline/v1beta1/taskrun_validation.go	97.0%	97.1%	0.1
pkg/entrypoint/entrypointer.go	87.6%	87.7%	0.1
pkg/pod/entrypoint.go	93.4%	93.5%	0.1
pkg/pod/script.go	99.0%	99.1%	0.1

tekton-robot · 2023-11-18T13:57:07Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/main.go	11.6%	12.7%	1.1
pkg/apis/pipeline/v1/taskrun_types.go	81.4%	82.8%	1.5
pkg/apis/pipeline/v1/taskrun_validation.go	96.9%	97.1%	0.1
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	93.3%	93.5%	0.2
pkg/apis/pipeline/v1beta1/taskrun_types.go	82.3%	83.6%	1.3
pkg/apis/pipeline/v1beta1/taskrun_validation.go	97.0%	97.1%	0.1
pkg/entrypoint/entrypointer.go	87.6%	87.7%	0.1
pkg/pod/entrypoint.go	93.4%	93.5%	0.1
pkg/pod/script.go	99.0%	99.1%	0.1

chengjoey · 2023-11-18T15:16:16Z

/test pull-tekton-pipeline-build-tests

tekton-robot · 2023-11-20T01:55:59Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/main.go	11.6%	12.7%	1.1
pkg/apis/pipeline/v1/taskrun_types.go	81.4%	82.8%	1.5
pkg/apis/pipeline/v1/taskrun_validation.go	96.9%	97.1%	0.1
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	93.3%	93.5%	0.2
pkg/apis/pipeline/v1beta1/taskrun_types.go	82.3%	83.6%	1.3
pkg/apis/pipeline/v1beta1/taskrun_validation.go	97.0%	97.1%	0.1
pkg/entrypoint/entrypointer.go	87.6%	87.7%	0.1
pkg/pod/entrypoint.go	93.4%	93.5%	0.1
pkg/pod/script.go	99.0%	99.1%	0.1

tekton-robot · 2023-11-20T01:57:30Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/main.go	11.6%	12.7%	1.1
pkg/apis/pipeline/v1/taskrun_types.go	81.4%	82.8%	1.5
pkg/apis/pipeline/v1/taskrun_validation.go	96.9%	97.1%	0.1
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	93.3%	93.5%	0.2
pkg/apis/pipeline/v1beta1/taskrun_types.go	82.3%	83.6%	1.3
pkg/apis/pipeline/v1beta1/taskrun_validation.go	97.0%	97.1%	0.1
pkg/entrypoint/entrypointer.go	87.6%	87.7%	0.1
pkg/pod/entrypoint.go	93.4%	93.5%	0.1
pkg/pod/script.go	99.0%	99.1%	0.1

tekton-robot · 2023-11-20T02:46:46Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/main.go	11.6%	12.7%	1.1
pkg/apis/pipeline/v1/taskrun_types.go	81.4%	82.8%	1.5
pkg/apis/pipeline/v1/taskrun_validation.go	96.9%	97.1%	0.1
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	93.3%	93.5%	0.2
pkg/apis/pipeline/v1beta1/taskrun_types.go	82.3%	83.6%	1.3
pkg/apis/pipeline/v1beta1/taskrun_validation.go	97.0%	97.1%	0.1
pkg/entrypoint/entrypointer.go	87.6%	87.7%	0.1
pkg/pod/entrypoint.go	93.4%	93.5%	0.1
pkg/pod/script.go	99.0%	99.1%	0.1

tekton-robot · 2023-11-20T02:47:36Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/main.go	11.6%	12.7%	1.1
pkg/apis/pipeline/v1/taskrun_types.go	81.4%	82.8%	1.5
pkg/apis/pipeline/v1/taskrun_validation.go	96.9%	97.1%	0.1
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	93.3%	93.5%	0.2
pkg/apis/pipeline/v1beta1/taskrun_types.go	82.3%	83.6%	1.3
pkg/apis/pipeline/v1beta1/taskrun_validation.go	97.0%	97.1%	0.1
pkg/entrypoint/entrypointer.go	87.6%	87.7%	0.1
pkg/pod/entrypoint.go	93.4%	93.5%	0.1
pkg/pod/script.go	99.0%	99.1%	0.1

chitrangpatel · 2023-12-19T14:40:34Z

/approve

tekton-robot · 2023-12-19T14:40:49Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: chitrangpatel

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [chitrangpatel]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

chengjoey · 2024-07-18T02:12:18Z

@chengjoey please rebase. This will pull in the image tagging changes introduced to hopefully get us past the CI Docker rate limit errors

i have reased, but it doesn't seem to work, I'll try test again later

tekton-robot · 2024-07-18T02:15:06Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/main.go	11.0%	11.9%	1.0
pkg/apis/pipeline/v1/taskrun_types.go	81.4%	82.8%	1.5
pkg/apis/pipeline/v1/taskrun_validation.go	97.0%	97.1%	0.1
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	92.8%	92.9%	0.1
pkg/apis/pipeline/v1beta1/taskrun_types.go	82.3%	83.6%	1.3
pkg/apis/pipeline/v1beta1/taskrun_validation.go	97.0%	97.1%	0.1
pkg/entrypoint/entrypointer.go	88.0%	88.0%	0.0
pkg/pod/entrypoint.go	93.4%	93.5%	0.1
pkg/pod/script.go	99.0%	99.1%	0.1

chitrangpatel · 2024-07-18T02:15:53Z

@chengjoey please rebase. This will pull in the image tagging changes introduced to hopefully get us past the CI Docker rate limit errors

i have reased, but it doesn't seem to work, I'll try test again later

yeah I think we are still being affected by the ongoing rate pull effect which exists for 6 hours!!

chengjoey · 2024-07-18T03:53:23Z

It looks a bit strange, is it because of golint upgrade?

chengjoey · 2024-07-18T07:18:58Z

/test pull-tekton-pipeline-alpha-integration-tests

chengjoey · 2024-07-18T09:13:39Z

/test pull-tekton-pipeline-build-tests

tekton-robot · 2024-08-02T02:46:07Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/main.go	11.0%	11.9%	1.0
pkg/apis/pipeline/v1/taskrun_types.go	81.4%	82.8%	1.5
pkg/apis/pipeline/v1/taskrun_validation.go	97.4%	97.4%	0.1
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	93.0%	93.1%	0.1
pkg/apis/pipeline/v1beta1/taskrun_types.go	82.3%	83.6%	1.3
pkg/apis/pipeline/v1beta1/taskrun_validation.go	97.4%	97.4%	0.1
pkg/entrypoint/entrypointer.go	88.0%	88.0%	0.0
pkg/pod/entrypoint.go	93.4%	93.5%	0.1
pkg/pod/script.go	99.0%	99.1%	0.1

tekton-robot · 2024-08-02T02:48:06Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/main.go	11.0%	11.9%	1.0
pkg/apis/pipeline/v1/taskrun_types.go	81.4%	82.8%	1.5
pkg/apis/pipeline/v1/taskrun_validation.go	97.4%	97.4%	0.1
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	93.0%	93.1%	0.1
pkg/apis/pipeline/v1beta1/taskrun_types.go	82.3%	83.6%	1.3
pkg/apis/pipeline/v1beta1/taskrun_validation.go	97.4%	97.4%	0.1
pkg/entrypoint/entrypointer.go	88.0%	88.0%	0.0
pkg/pod/entrypoint.go	93.4%	93.5%	0.1
pkg/pod/script.go	99.0%	99.1%	0.1

tekton-robot · 2024-08-02T06:17:26Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/main.go	11.0%	11.9%	1.0
pkg/apis/pipeline/v1/taskrun_types.go	81.4%	82.8%	1.5
pkg/apis/pipeline/v1/taskrun_validation.go	97.4%	97.4%	0.1
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	93.0%	93.1%	0.1
pkg/apis/pipeline/v1beta1/taskrun_types.go	82.3%	83.6%	1.3
pkg/apis/pipeline/v1beta1/taskrun_validation.go	97.4%	97.4%	0.1
pkg/entrypoint/entrypointer.go	88.0%	88.0%	0.0
pkg/pod/entrypoint.go	93.4%	93.5%	0.1
pkg/pod/script.go	99.0%	99.1%	0.1

tekton-robot · 2024-08-02T06:19:28Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/main.go	11.0%	11.9%	1.0
pkg/apis/pipeline/v1/taskrun_types.go	81.4%	82.8%	1.5
pkg/apis/pipeline/v1/taskrun_validation.go	97.4%	97.4%	0.1
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	93.0%	93.1%	0.1
pkg/apis/pipeline/v1beta1/taskrun_types.go	82.3%	83.6%	1.3
pkg/apis/pipeline/v1beta1/taskrun_validation.go	97.4%	97.4%	0.1
pkg/entrypoint/entrypointer.go	88.0%	88.0%	0.0
pkg/pod/entrypoint.go	93.4%	93.5%	0.1
pkg/pod/script.go	99.0%	99.1%	0.1

tekton-robot · 2024-08-02T07:07:22Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/main.go	11.0%	11.9%	1.0
pkg/apis/pipeline/v1/taskrun_types.go	81.4%	82.8%	1.5
pkg/apis/pipeline/v1/taskrun_validation.go	97.4%	97.4%	0.1
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	93.0%	93.1%	0.1
pkg/apis/pipeline/v1beta1/taskrun_types.go	82.3%	83.6%	1.3
pkg/apis/pipeline/v1beta1/taskrun_validation.go	97.4%	97.4%	0.1
pkg/entrypoint/entrypointer.go	88.0%	88.0%	0.1
pkg/pod/entrypoint.go	93.4%	93.5%	0.1
pkg/pod/script.go	99.0%	99.1%	0.1

tekton-robot · 2024-08-02T07:10:12Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/main.go	11.0%	11.9%	1.0
pkg/apis/pipeline/v1/taskrun_types.go	81.4%	82.8%	1.5
pkg/apis/pipeline/v1/taskrun_validation.go	97.4%	97.4%	0.1
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	93.0%	93.1%	0.1
pkg/apis/pipeline/v1beta1/taskrun_types.go	82.3%	83.6%	1.3
pkg/apis/pipeline/v1beta1/taskrun_validation.go	97.4%	97.4%	0.1
pkg/entrypoint/entrypointer.go	88.0%	88.0%	0.1
pkg/pod/entrypoint.go	93.4%	93.5%	0.1
pkg/pod/script.go	99.0%	99.1%	0.1

tekton-robot · 2024-08-02T07:50:05Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/main.go	11.0%	11.9%	1.0
pkg/apis/pipeline/v1/taskrun_types.go	81.4%	82.8%	1.5
pkg/apis/pipeline/v1/taskrun_validation.go	97.4%	97.4%	0.1
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	93.0%	93.1%	0.1
pkg/apis/pipeline/v1beta1/taskrun_types.go	82.3%	83.6%	1.3
pkg/apis/pipeline/v1beta1/taskrun_validation.go	97.4%	97.4%	0.1
pkg/entrypoint/entrypointer.go	88.0%	88.1%	0.1
pkg/pod/entrypoint.go	93.4%	93.5%	0.1
pkg/pod/script.go	99.0%	99.1%	0.1

tekton-robot · 2024-08-02T07:51:01Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/main.go	11.0%	11.9%	1.0
pkg/apis/pipeline/v1/taskrun_types.go	81.4%	82.8%	1.5
pkg/apis/pipeline/v1/taskrun_validation.go	97.4%	97.4%	0.1
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	93.0%	93.1%	0.1
pkg/apis/pipeline/v1beta1/taskrun_types.go	82.3%	83.6%	1.3
pkg/apis/pipeline/v1beta1/taskrun_validation.go	97.4%	97.4%	0.1
pkg/entrypoint/entrypointer.go	88.0%	88.1%	0.1
pkg/pod/entrypoint.go	93.4%	93.5%	0.1
pkg/pod/script.go	99.0%	99.1%	0.1

Signed-off-by: chengjoey <[email protected]>

tekton-robot · 2024-08-02T08:10:56Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/main.go	11.0%	11.9%	1.0
pkg/apis/pipeline/v1/taskrun_types.go	81.4%	82.8%	1.5
pkg/apis/pipeline/v1/taskrun_validation.go	97.4%	97.4%	0.1
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	93.0%	93.1%	0.1
pkg/apis/pipeline/v1beta1/taskrun_types.go	82.3%	83.6%	1.3
pkg/apis/pipeline/v1beta1/taskrun_validation.go	97.4%	97.4%	0.1
pkg/entrypoint/entrypointer.go	88.0%	88.1%	0.1
pkg/pod/entrypoint.go	93.4%	93.5%	0.1
pkg/pod/script.go	99.0%	99.1%	0.1

tekton-robot · 2024-08-02T08:12:45Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/main.go	11.0%	11.9%	1.0
pkg/apis/pipeline/v1/taskrun_types.go	81.4%	82.8%	1.5
pkg/apis/pipeline/v1/taskrun_validation.go	97.4%	97.4%	0.1
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	93.0%	93.1%	0.1
pkg/apis/pipeline/v1beta1/taskrun_types.go	82.3%	83.6%	1.3
pkg/apis/pipeline/v1beta1/taskrun_validation.go	97.4%	97.4%	0.1
pkg/entrypoint/entrypointer.go	88.0%	88.1%	0.1
pkg/pod/entrypoint.go	93.4%	93.5%	0.1
pkg/pod/script.go	99.0%	99.1%	0.1

chengjoey · 2024-08-02T08:37:32Z

@chitrangpatel , now all the checks have passed~

afrittoli

Thank you for this! Just a few minor comments, otherwise it looks good!
Please let me know if you prefer to merge this and address the comments in a follow-up PR.

afrittoli · 2024-08-02T09:03:15Z

docs/debug.md

+### Breakpoint before step
+
+
+TaskRun will be stuck waiting for user debugging before the step execution.


NIT: The TaskRun will be wait for use input before starting the execution of the step

afrittoli · 2024-08-02T09:05:38Z

docs/debug.md

+
+
+TaskRun will be stuck waiting for user debugging before the step execution.
+When beforeStep-Breakpoint takes effect, the user can see the following information


NIT: what's "beforeStep-Breakpoint"? If it is the name of a configuration option or variable please use the inline code-block, else please use a description in plain english i.e. "When the breakpoint before step takes effect"

afrittoli · 2024-08-02T09:07:27Z

docs/debug.md

+1. Executing /tekton/debug/scripts/debug-beforestep-continue will continue to execute the step program
+2. Executing /tekton/debug/scripts/debug-beforestep-fail-continue will not continue to execute the task, and will mark the step as failed


NIT: please wrap the file-paths with inline code blocks (e.g. `code block`)

afrittoli · 2024-08-02T09:08:22Z

docs/debug.md

@@ -80,7 +95,13 @@ to reflect step number. eg: Step 0 will have `/tekton/debug/info/0`, Step 1 will
 ### Debug Scripts

 `/tekton/debug/scripts/debug-continue` : Mark the step as completed with success by writing to `/tekton/run`. eg: User wants to exit
-breakpoint for failed step 0. Running this script would create `/tekton/run/0` and `/tekton/run/0.breakpointexit`.
+onfailure breakpoint for failed step 0. Running this script would create `/tekton/run/0` and `/tekton/run/0/out.breakpointexit`.


NIT: breakpoint on failure

afrittoli · 2024-08-02T09:08:32Z

docs/debug.md


 `/tekton/debug/scripts/debug-fail-continue` : Mark the step as completed with failure by writing to `/tekton/run`. eg: User wants to exit
-breakpoint for failed step 0. Running this script would create `/tekton/run/0.err` and `/tekton/run/0.breakpointexit`.
+onfailure breakpoint for failed step 0. Running this script would create `/tekton/run/0` and `/tekton/run/0/out.breakpointexit.err`.


afrittoli · 2024-08-02T09:26:31Z

pkg/apis/pipeline/v1/taskrun_types.go

+}
+
+// HaveBeforeSteps return true if have any before steps
+func (trd *TaskRunDebug) HaveBeforeSteps() bool {


NIT: to be consistent with other method names, this should be HasBeforeSteps

afrittoli · 2024-08-02T09:53:43Z

pkg/apis/pipeline/v1/taskrun_validation.go

+	beforeSteps := sets.NewString()
+	for i, step := range db.Breakpoints.BeforeSteps {
+		if beforeSteps.Has(step) {
+			errs = errs.Also(apis.ErrGeneric(fmt.Sprintf("before step must be unique, the same step: %s is defined multiple times at", step), fmt.Sprintf("breakpoints.beforeSteps[%d]", i)))
+		}
+		beforeSteps.Insert(step)
+	}


It's a pity that we cannot always validate here that the step names provided are actually valid (since resources are not resolved yet), but we could do so at least in the case of embedded specification.
We could validate the case of referenced spec at runtime too. Either case, silently ignoring non-existent step names would not be helpful for users, I think it would be better to fail the TaskRun and report that a step on the list does not exists. WDYT?
This could be an enhancement in a follow-up PR if you agree.

afrittoli · 2024-08-02T10:07:16Z

pkg/entrypoint/entrypointer.go

+}
+
+var (
+	errDebugBeforeStep = DebugBeforeStepError("before step breakpoint error file, user decided to skip the current step execution")


I'm not sure I understand the meaning of this.
I'm guessing that "an error was encountered while waiting for the before-step breakpoint file because the user decided to skip the execution of the step"? Could you clarify?

Maybe it could be rephrased as: "before-step breakpoint: step execution skipped by the user"?

afrittoli · 2024-08-02T10:12:12Z

pkg/entrypoint/entrypointer.go

-			logger.Fatalf("Error while handling task artifacts: %s", err)
-		}
-		output = append(output, artifacts...)
+		e.appendArtifactOutputs(&output, logger)


What's the reason for moving this code to a function? It does not help with testing and it is not re-used anywhere else.

afrittoli · 2024-08-02T10:16:19Z

cmd/entrypoint/main.go

-				checkForBreakpointOnFailure(e, breakpointExitPostFile)
+				e.CheckForBreakpointOnFailure()


Nice, but it seems unrelated to this PR.
Is the reason for making CheckForBreakpointOnFailure public is to provide unit test coverage?

chengjoey · 2024-08-03T04:42:45Z

Thank you for this! Just a few minor comments, otherwise it looks good! Please let me know if you prefer to merge this and address the comments in a follow-up PR.

Thanks @afrittoli for your comments. Yes, I hope to merge this PR and fix the issues raised in your comments in a follow-up PR, and I will fix them before the next milestone.

chitrangpatel · 2024-08-22T18:49:32Z

Merging now.
/lgtm

tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Nov 18, 2023

tekton-robot requested review from abayer and vdemeester November 18, 2023 05:21

tekton-robot added the kind/feature Categorizes issue or PR as related to a new feature. label Nov 18, 2023

tekton-robot assigned chitrangpatel and lbernick Nov 18, 2023

chengjoey force-pushed the feat/TEP-009-breakpoint-before-step branch from 5ffee60 to e15525f Compare November 18, 2023 13:49

chengjoey force-pushed the feat/TEP-009-breakpoint-before-step branch from e15525f to 49f4641 Compare November 20, 2023 01:49

chengjoey force-pushed the feat/TEP-009-breakpoint-before-step branch from 49f4641 to c5befb0 Compare November 20, 2023 02:40

tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 19, 2023

chitrangpatel added this to the Pipelines v0.56 milestone Jan 9, 2024

tekton-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 17, 2024

chitrangpatel modified the milestones: Pipelines v0.56, Pipelines v0.57 Jan 19, 2024

chengjoey force-pushed the feat/TEP-009-breakpoint-before-step branch from c5befb0 to 9e2e2f3 Compare January 25, 2024 03:47

tekton-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 25, 2024

chitrangpatel modified the milestones: Pipeline v0.62, Pipeline v0.63 Jul 24, 2024

chengjoey force-pushed the feat/TEP-009-breakpoint-before-step branch from 00e2654 to 49779a3 Compare August 2, 2024 02:35

chengjoey force-pushed the feat/TEP-009-breakpoint-before-step branch from 49779a3 to 02a269e Compare August 2, 2024 06:07

chengjoey force-pushed the feat/TEP-009-breakpoint-before-step branch from 02a269e to 4052462 Compare August 2, 2024 06:57

chengjoey force-pushed the feat/TEP-009-breakpoint-before-step branch from 4052462 to 88240b8 Compare August 2, 2024 07:41

TEP-0097 breakpoint before steps for taskrun

b7ee47e

Signed-off-by: chengjoey <[email protected]>

chengjoey force-pushed the feat/TEP-009-breakpoint-before-step branch from 88240b8 to b7ee47e Compare August 2, 2024 08:00

afrittoli reviewed Aug 2, 2024

View reviewed changes

tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 22, 2024

tekton-robot merged commit 4f04964 into tektoncd:main Aug 22, 2024
14 checks passed

		### Breakpoint before step


		TaskRun will be stuck waiting for user debugging before the step execution.



		TaskRun will be stuck waiting for user debugging before the step execution.
		When beforeStep-Breakpoint takes effect, the user can see the following information

		1. Executing /tekton/debug/scripts/debug-beforestep-continue will continue to execute the step program
		2. Executing /tekton/debug/scripts/debug-beforestep-fail-continue will not continue to execute the task, and will mark the step as failed

		checkForBreakpointOnFailure(e, breakpointExitPostFile)
		e.CheckForBreakpointOnFailure()

TEP-0097 breakpoint before steps for taskrun #7391

TEP-0097 breakpoint before steps for taskrun #7391

Conversation

chengjoey commented Nov 18, 2023 • edited Loading

Changes

Submitter Checklist

Release Notes

chengjoey commented Nov 18, 2023

chengjoey commented Nov 18, 2023

tekton-robot commented Nov 18, 2023

tekton-robot commented Nov 18, 2023

tekton-robot commented Nov 18, 2023

tekton-robot commented Nov 18, 2023

chengjoey commented Nov 18, 2023

tekton-robot commented Nov 20, 2023

tekton-robot commented Nov 20, 2023

tekton-robot commented Nov 20, 2023

tekton-robot commented Nov 20, 2023

chitrangpatel commented Dec 19, 2023

tekton-robot commented Dec 19, 2023

chengjoey commented Jul 18, 2024

tekton-robot commented Jul 18, 2024

chitrangpatel commented Jul 18, 2024

chengjoey commented Jul 18, 2024

chengjoey commented Jul 18, 2024

chengjoey commented Jul 18, 2024

tekton-robot commented Aug 2, 2024

tekton-robot commented Aug 2, 2024

tekton-robot commented Aug 2, 2024

tekton-robot commented Aug 2, 2024

tekton-robot commented Aug 2, 2024

tekton-robot commented Aug 2, 2024

tekton-robot commented Aug 2, 2024

tekton-robot commented Aug 2, 2024

tekton-robot commented Aug 2, 2024

tekton-robot commented Aug 2, 2024

chengjoey commented Aug 2, 2024

afrittoli left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chengjoey commented Aug 3, 2024

chitrangpatel commented Aug 22, 2024

chengjoey commented Nov 18, 2023 •

edited

Loading