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.

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

Jump to bottom

Add additional documentation. #475

Merged
merged 1 commit into from
Mar 20, 2020
Merged

Add additional documentation. #475

merged 1 commit into from
Mar 20, 2020

Conversation

bigkevmcd
Copy link
Member

Changes

Adds additional documentation for the CEL interceptor.

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

See the contribution guide for more details.

Release Notes

Improved documentation for CEL interceptor overlays

@tekton-robot tekton-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 10, 2020
@bigkevmcd
Copy link
Member Author

/retest all

@bigkevmcd
Copy link
Member Author

/test pull-tekton-triggers-build-tests

@bigkevmcd bigkevmcd force-pushed the improve-documentation-overlays branch from 5144eb5 to ffc2fc4 Compare March 10, 2020 17:19
dibyom
dibyom reviewed Mar 10, 2020
View reviewed changes
Copy link
Member

@dibyom dibyom left a comment •
edited
Loading

Choose a reason for hiding this comment

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

This looks great! One request: Can we update the description of the CEL Interceptors section to say something like CEL Interceptors can be used to filter or modify incoming events. And then have two sub-sections one for Overlays (like the one you added here) and one for Filters?

@bigkevmcd bigkevmcd force-pushed the improve-documentation-overlays branch from ffc2fc4 to 346c860 Compare March 10, 2020 18:05
@tekton-robot tekton-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 10, 2020
@bigkevmcd
Copy link
Member Author

This is failing, but I can't really see why.

I0310 18:06:14.886] --------------------------------
I0310 18:06:14.887] ---- Linting the yaml files ----
I0310 18:06:14.887] --------------------------------
I0310 18:09:08.970] level=error msg="Timeout exceeded: try increase it by passing --timeout option"
I0310 18:09:09.187] Diffing against the documentation yaml
I0310 18:09:09.481] ============================
I0310 18:09:09.482] ==== BUILD TESTS FAILED ====
I0310 18:09:09.483] ============================
W0310 18:09:09.584] Run: ('/workspace/./test-infra/jenkins/../scenarios/../hack/coalesce.py',)
E0310 18:09:09.690] Command failed
I0310 18:09:09.691] process 473 exited with code 1 after 3.0m

@dibyom
Copy link
Member

dibyom commented Mar 10, 2020

@bigkevmcd I've noticed some flakiness in our build tests especially when the commits contain markdown files :(

@dibyom
Copy link
Member

dibyom commented Mar 10, 2020

/test pull-tekton-triggers-build-tests

@bigkevmcd bigkevmcd force-pushed the improve-documentation-overlays branch from 346c860 to 3269a96 Compare March 12, 2020 20:29
@dibyom
Copy link
Member

dibyom commented Mar 12, 2020

/test pull-tekton-triggers-integration-tests

@bigkevmcd
Add additional documentation.
3e78c4c 
This adds additional documentation for using the CEL interceptor's _overlays_ feature.

Includes examples of before and after, and using the values from a binding.
@bigkevmcd bigkevmcd force-pushed the improve-documentation-overlays branch from 3269a96 to 3e78c4c Compare March 13, 2020 07:53
dibyom
dibyom approved these changes Mar 20, 2020
View reviewed changes
Copy link
Member

@dibyom dibyom left a comment

Choose a reason for hiding this comment

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

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Mar 20, 2020
@tekton-robot
Copy link

[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:

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

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 20, 2020
@tekton-robot tekton-robot merged commit 20d725e into tektoncd:master Mar 20, 2020
@bigkevmcd bigkevmcd deleted the improve-documentation-overlays branch March 26, 2020 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dibyom dibyom dibyom approved these changes

@dlorenc dlorenc Awaiting requested review from dlorenc

@vtereso vtereso Awaiting requested review from vtereso

Assignees

@dibyom dibyom

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cla: yes lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@bigkevmcd @dibyom @tekton-robot @googlebot