Skip to content
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.

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

RHDEVDOCS 5729 overriding a task in remote pipeline #68447

Merged
merged 1 commit into from
Nov 29, 2023

Conversation

mramendi
Copy link
Contributor

@mramendi mramendi commented Nov 28, 2023

Version(s):

cp to pipelines-docs-1.13

Issue:

RHDEVDOCS 5729

Link to docs preview:

https://68447--docspreview.netlify.app/openshift-pipelines/latest/pac/using-pac-resolver#overriding-tasks-in-remote-pipeline_using-pac-resolver

QE review:

  • QE has approved this change.

Additional information:

@openshift-ci openshift-ci bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 28, 2023
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Nov 28, 2023

🤖 Updated build preview is available at:
https://68447--docspreview.netlify.app

Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/34921


By default, if you use a remote pipeline annotation in a pipeline run, {pac} uses all the tasks that are a part of the remote pipeline.

To override a task, you can add an annotation for a task with the same name to the remote pipeline annotation.

Choose a reason for hiding this comment

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

nit: task with the same name as in remote pipeline to the pipelinerun annotation

@piyush-garg
Copy link

lgtm

@mramendi
Copy link
Contributor Author

/label peer-review-needed

@openshift-ci openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Nov 28, 2023
@mburke5678 mburke5678 added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Nov 28, 2023
@mburke5678 mburke5678 added this to the Continuous Release milestone Nov 28, 2023

By default, if you use a remote pipeline annotation in a pipeline run, {pac} uses all the tasks that are a part of the remote pipeline.

To override a task, you can add an annotation for a task with the same name as a task in the pipeline that the remote pipeline annotation references.
Copy link
Contributor

Choose a reason for hiding this comment

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

This line is not clear to me, but I am not familiar with pipelines. Maybe something like:

Suggested change
To override a task, you can add an annotation for a task with the same name as a task in the pipeline that the remote pipeline annotation references.
You can override a task in a remote pipeline by adding a task that has the same name as an annotation in the pipeline run.

@mburke5678
Copy link
Contributor

@mramendi One nit. Otherwise LGTM

@mburke5678 mburke5678 added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR peer-review-needed Signifies that the peer review team needs to review this PR labels Nov 28, 2023
@mramendi
Copy link
Contributor Author

/label merge-review-needed

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Nov 29, 2023
@bergerhoffer
Copy link
Contributor

/label merge-review-in-progress

@openshift-ci openshift-ci bot added the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Nov 29, 2023
Copy link
Contributor

@bergerhoffer bergerhoffer left a comment

Choose a reason for hiding this comment

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

Added two questions/comments, but not holding the merge since it was QE reviewed and the other comment is minor.

But please consider checking these and making a future update if one is needed

.Example pipeline run definition referencing a remote pipeline and overriding a task
[source,yaml]
----
kind: PipelineRun
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this have an apiVersion here?

pipelinesascode.tekton.dev/task: "./my-git-clone-task.yaml"
----

For this example, assume the remote task found at \https://git.provider/raw/pipeline.yaml includes a task named `git-clone` and the task that the `my-git-clone-task.yaml` file defines is also named `git-clone`.
Copy link
Contributor

Choose a reason for hiding this comment

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

the URL here should probably be in backticks

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@bergerhoffer I agree with your notes and thanks for not holding the merge! We have a GA tomorrow and the suggested changes require a new round of reviews. I am making a separate PR but it might get merged after the GA.

@bergerhoffer bergerhoffer merged commit 2f96011 into openshift:pipelines-docs Nov 29, 2023
1 check passed
@bergerhoffer
Copy link
Contributor

/cherrypick pipelines-docs-1.13

@openshift-cherrypick-robot

@bergerhoffer: new pull request created: #68557

In response to this:

/cherrypick pipelines-docs-1.13

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge-review-in-progress Signifies that the merge review team is reviewing this PR merge-review-needed Signifies that the merge review team needs to review this PR peer-review-done Signifies that the peer review team has reviewed this PR size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants