fix(example): update default branch name in examples #1748

l-qing · 2024-07-07T16:04:01Z

Changes

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

NONE

/kind documentation

tekton-robot · 2024-07-07T16:04:10Z

Hi @l-qing. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

l-qing · 2024-07-07T16:05:18Z

examples/v1alpha1/cron/triggerbinding.yaml

@@ -5,6 +5,6 @@ metadata:
 spec:
  params:
  - name: gitrevision
-    value: master
+    value: main


In this demo, cloning the master branch will fail because it has been renamed to main.

l-qing · 2024-07-07T16:07:25Z

examples/v1beta1/triggertemplates/triggertemplate.yaml

@@ -14,6 +14,7 @@ spec:
    default: This is the default message
  - name: contenttype
    description: The Content-Type of the event
+    default: text/plain


In this demo, without a default value and without assigning value in TriggerBinding, the default value $(tt.params.contenttype) will be retained in TaskRun, which is quite strange.

Do you mean to say we get $(tt.params.contenttype) when there's no value in TriggerBinding and no default value? It should during processing of events then,

Yes, I understand that this value should be declared in the TriggerBinding as the source of the contenttype variable, which can be either $(body.xxx) or $(extensions.xxx). However, I am not aware of any existing data source to obtain this parameter value, and it is not mentioned in the documentation.

So my current solution is to give it a default value first, which will not affect other TriggerBindings assigning it a suitable value in the future.

I referred to the code here and also added a configuration in TriggerBinding to assign a value to contenttype.

triggers/examples/v1beta1/trigger-ref/triggerbinding.yaml

Lines 5 to 12 in 87e123e

spec:

params:

- name: gitrevision

value: $(body.head_commit.id)

- name: gitrepositoryurl

value: $(body.repository.url)

- name: contenttype

value: $(header.Content-Type)

Hey @l-qing when there is not default value what is the issue

If there is no default value, it will not necessarily cause a problem.
It will only cause an issue if there is also no value assigned in the TriggerBinding.

khrm

/ok-to-test

khrm · 2024-07-08T00:38:19Z

/test pull-tekton-triggers-build-tests

l-qing · 2024-07-08T08:49:26Z

examples/v1beta1/cron/triggerbinding.yaml

  - name: gitrepositoryurl
    value: https://github.com/tektoncd/triggers
+  - name: contenttype
+    value: $(header.Content-Type)


Ref:

triggers/examples/v1beta1/trigger-ref/triggerbinding.yaml

Lines 5 to 12 in 87e123e

spec:

params:

- name: gitrevision

value: $(body.head_commit.id)

- name: gitrepositoryurl

value: $(body.repository.url)

- name: contenttype

value: $(header.Content-Type)

tekton-robot · 2024-07-09T03:55:56Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dibyom

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~~ [dibyom]

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

l-qing · 2024-08-06T03:09:21Z

/auto-cc

savitaashture

/lgtm

tekton-robot requested review from bobcatfish and iancoffey July 7, 2024 16:04

l-qing commented Jul 7, 2024

View reviewed changes

khrm reviewed Jul 7, 2024

View reviewed changes

tekton-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 7, 2024

l-qing force-pushed the fix/branch-name-in-examples branch from 1972134 to 0321ebb Compare July 8, 2024 02:10

l-qing commented Jul 8, 2024

View reviewed changes

dibyom approved these changes Jul 9, 2024

View reviewed changes

tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 9, 2024

tekton-robot requested review from dibyom and khrm August 6, 2024 03:09

l-qing added 2 commits August 12, 2024 14:45

fix(example): update default branch name in examples

d0ed482

chore: add correct contenttype to triggerbinding examples

584772f

l-qing force-pushed the fix/branch-name-in-examples branch from ea25fb0 to 584772f Compare August 12, 2024 06:45

savitaashture reviewed Aug 21, 2024

View reviewed changes

tekton-robot assigned savitaashture Aug 21, 2024

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

tekton-robot merged commit b7a7987 into tektoncd:main Aug 21, 2024
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(example): update default branch name in examples #1748

fix(example): update default branch name in examples #1748

l-qing commented Jul 7, 2024

tekton-robot commented Jul 7, 2024

l-qing Jul 7, 2024

l-qing Jul 7, 2024

khrm Jul 8, 2024

l-qing Jul 8, 2024

l-qing Jul 8, 2024

savitaashture Aug 13, 2024

l-qing Aug 14, 2024

khrm left a comment

khrm commented Jul 8, 2024

l-qing Jul 8, 2024

tekton-robot commented Jul 9, 2024

l-qing commented Aug 6, 2024

savitaashture left a comment

	spec:
	params:
	- name: gitrevision
	value: $(body.head_commit.id)
	- name: gitrepositoryurl
	value: $(body.repository.url)
	- name: contenttype
	value: $(header.Content-Type)

fix(example): update default branch name in examples #1748

fix(example): update default branch name in examples #1748

Conversation

l-qing commented Jul 7, 2024

Changes

Submitter Checklist

Release Notes

tekton-robot commented Jul 7, 2024

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

khrm left a comment

Choose a reason for hiding this comment

khrm commented Jul 8, 2024

Choose a reason for hiding this comment

tekton-robot commented Jul 9, 2024

l-qing commented Aug 6, 2024

savitaashture left a comment

Choose a reason for hiding this comment