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

Enhancements for PullRequest Resource docs #1276

Merged
merged 1 commit into from
Sep 16, 2019
Merged

Enhancements for PullRequest Resource docs #1276

merged 1 commit into from
Sep 16, 2019

Conversation

hrishin
Copy link
Member

@hrishin hrishin commented Sep 5, 2019 •
edited
Loading

Changes

It seems like users may not able able to understand
how to use the PullRequestResource with secrete configuration

This patch adds an example TaskRun/Task to demonstrate
how to use the PR Resource.

Fixes #1275

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.

@googlebot googlebot added the cla: yes Trying to make the CLA bot happy with ppl from different companies work on one commit label Sep 5, 2019
@tekton-robot tekton-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 5, 2019
@hrishin
Copy link
Member Author

hrishin commented Sep 5, 2019

/retest

@ghost
Copy link

ghost commented Sep 5, 2019

The example you've added is being executed as part of the YAML tests and appears to be failing because the secret's token isn't valid base64.

Here's the error I'm seeing in the integration test output:

I0905 11:07:06.706] Error from server (BadRequest): error when creating "STDIN": Secret in version "v1" cannot be handled as a Secret: v1.Secret.ObjectMeta: v1.ObjectMeta.TypeMeta: Kind: Data: decode base64: illegal base64 data at input byte 6, error found in #10 byte of ...|n_secrete"},"kind":"|..., bigger context ...|Version":"v1","data":{"token":"github_pan_secrete"},"kind":"Secret","metadata":{"annotations":{"kube|...
I0905 11:07:06.718] 2019/09/05 11:07:06 error executing 'kubectl apply': exit status 1
... <snip> ...
I0905 11:17:39.638] ERROR: test pull-request-example=SucceededUnknown but should be succeededtrue

@hrishin
Copy link
Member Author

hrishin commented Sep 5, 2019 •
edited
Loading

@sbwsg ahh Thank you for pointing exact issue (thought so 😅 ).
Is there any workaround for it? I guess we need to update the doc only and drop the example.

@ghost
Copy link

ghost commented Sep 5, 2019

It's up to you - if you want this example to be executed as part of the test suite (and therefore verified as working with each PR) then I suggest fixing the base64 string.

Otherwise, adding the example to documentation instead would be the way to go!

@tekton-robot tekton-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 5, 2019
@hrishin
Copy link
Member Author

hrishin commented Sep 5, 2019

@sbwsg I think its better have it into the documentation.

ghost
ghost reviewed Sep 5, 2019
View reviewed changes
docs/resources.md Outdated Show resolved Hide resolved
@hrishin
Copy link
Member Author

hrishin commented Sep 6, 2019

/hold

@tekton-robot tekton-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 6, 2019
@ghost
Copy link

ghost commented Sep 6, 2019

/lgtm

@tekton-robot tekton-robot assigned ghost Sep 6, 2019
@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Sep 6, 2019
@hrishin
Copy link
Member Author

hrishin commented Sep 9, 2019

holding it for #1275 (comment)

@ghost ghost mentioned this pull request Sep 11, 2019
Closed
dibyom
dibyom reviewed Sep 12, 2019
View reviewed changes
docs/resources.md Outdated Show resolved Hide resolved
@hrishin
Enhancements for PullRequest Resource docs
ed78271 
It seems like users may not able able to understand
how to use the `PullRequestResource` with secret configuration.

This patch updates the docs with example Task with Secret
to demonstrate how to use the PR Resource.

Fixes tektoncd#1275
@tekton-robot tekton-robot removed the lgtm Indicates that a PR is ready to be merged. label Sep 14, 2019
@hrishin
Copy link
Member Author

hrishin commented Sep 14, 2019

/hold cancel

@tekton-robot tekton-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 14, 2019
@ghost
Copy link

ghost commented Sep 16, 2019

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Sep 16, 2019
vdemeester
vdemeester approved these changes Sep 16, 2019
View reviewed changes
Copy link
Member

@vdemeester vdemeester 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
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hrishin, vdemeester

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 Sep 16, 2019
@tekton-robot tekton-robot merged commit f12922f into tektoncd:master Sep 16, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dibyom dibyom dibyom left review comments

@vdemeester vdemeester vdemeester approved these changes

@dlorenc dlorenc Awaiting requested review from dlorenc

@imjasonh imjasonh Awaiting requested review from imjasonh

Assignees

@vdemeester vdemeester

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cla: yes Trying to make the CLA bot happy with ppl from different companies work on one commit lgtm Indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

PullRequestResource resource usage
5 participants
@hrishin @tekton-robot @vdemeester @dibyom @googlebot