-
Notifications
You must be signed in to change notification settings - Fork 420
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
Conversation
4a0880d
to
037a4d8
Compare
@@ -1,7 +0,0 @@ | |||
apiVersion: v1 | |||
kind: Secret |
There was a problem hiding this comment.
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
examples/github/README.md
Outdated
|
||
1. Test by sending the sample payload. | ||
|
||
```shell script |
There was a problem hiding this comment.
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
examples/github/README.md
Outdated
|
||
The response status code should be `201 Created` | ||
|
||
[`HMAC`](https://www.freeformatter.com/hmac-generator.html) tool used to create X-Hub-Signature |
There was a problem hiding this comment.
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?
examples/github/README.md
Outdated
1. You should see a new PipelineRun that got created: | ||
|
||
```shell script | ||
kubectl get pipelinerun |
There was a problem hiding this comment.
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
examples/github/binding.yaml
Outdated
@@ -0,0 +1 @@ | |||
../role-resources/triggerbinding-roles/binding.yaml |
There was a problem hiding this comment.
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
Thanks for addressing the comments. Just two things:
|
aede251
to
a492d47
Compare
Thank you
I have a question here is if we squash commits we actually loose the history of review comments 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). |
/approve |
[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 |
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.