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

Refactored examples and added github example with README #576

Merged
merged 1 commit into from
May 21, 2020

Conversation

savitaashture
Copy link
Contributor

@savitaashture savitaashture commented May 14, 2020

Changes

Refactored examples and added github example along with README

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.

@tekton-robot tekton-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 14, 2020
@savitaashture savitaashture force-pushed the github-example branch 2 times, most recently from 4a0880d to 037a4d8 Compare May 14, 2020 18:55
@@ -1,7 +0,0 @@
apiVersion: v1
kind: Secret
Copy link
Member

Choose a reason for hiding this comment

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

I mentioned this in the BitBucket PR but I think its nicer to have each example that uses a secret create and use its own as opposed to sharing a common secret


1. Test by sending the sample payload.

```shell script
Copy link
Member

Choose a reason for hiding this comment

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

shell-script or bash instead of shell script everywhere in this file


The response status code should be `201 Created`

[`HMAC`](https://www.freeformatter.com/hmac-generator.html) tool used to create X-Hub-Signature
Copy link
Member

Choose a reason for hiding this comment

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

Thanks for adding this! Might be overkill but we could mention that the "string" is the body and the secretKey is from the example secret?

1. You should see a new PipelineRun that got created:

```shell script
kubectl get pipelinerun
Copy link
Member

Choose a reason for hiding this comment

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

Again, if we used our own pipeline/taskrun here, it would be easier to track what got created

@@ -0,0 +1 @@
../role-resources/triggerbinding-roles/binding.yaml
Copy link
Member

Choose a reason for hiding this comment

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

As I mentioned in #578 , I'd prefer adding the binding/template/pipeline/secret in this folder in the same file as it makes it much clearer what is going on (just look at this one file vs looking at 6-7 different files). I know this leads to some duplication but for examples I'm ok with having some repetition in order to help with clarity

@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 May 19, 2020
@dibyom
Copy link
Member

dibyom commented May 20, 2020

Thanks for addressing the comments. Just two things:

  1. Could we put the role/binding/serviceaccount file in one file (say, role.yaml)?
  2. Can we squash the commits into one?
    Otherwise LGTM!

@savitaashture
Copy link
Contributor Author

Thanks for addressing the comments. Just two things:

  1. Could we put the role/binding/serviceaccount file in one file (say, role.yaml)?
  2. Can we squash the commits into one?
    Otherwise LGTM!

Thank you

  1. Modified based on the suggestion
  2. squashed commits

I have a question here is if we squash commits we actually loose the history of review comments fix 🤔
I know this is small PR but in case of big feature its actually make sense to keep the history of commits so that it will be easy for the reviewers to see actual fix.

@dibyom
Copy link
Member

dibyom commented May 21, 2020

I have a question here is if we squash commits we actually loose the history of review comments fix 🤔
I know this is small PR but in case of big feature its actually make sense to keep the history of commits so that it will be easy for the reviewers to see actual fix.

Yeah, unfortunately GitHub code review does not handle diffs across commits well. And it is indeed helpful during review to see what comments are addressed. However, I think squashing still makes sense. Otherwise, the master branch gets cluttered with a bunch of small commits which makes it hard to rollback/cherry-pick (as well as figure out exactly what happened).

@dibyom
Copy link
Member

dibyom commented May 21, 2020

/approve
/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label May 21, 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 May 21, 2020
@tekton-robot tekton-robot merged commit 61a2e7b into tektoncd:master May 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. 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
Development

Successfully merging this pull request may close these issues.

3 participants