homedepot / github-webhook-resource

Concourse resource for remotely managing GitHub webhooks
Apache License 2.0
12 stars 20 forks source link

unclear what this is #18

Open ghost opened 4 years ago

ghost commented 4 years ago

Describe your change request

It doesn't seem clear from the docs whether this is a resource to manage webhooks or to manage git via webhooks.

You should clarify. Is this used to create a resource on a pipeline which represents a git repo and is updated by a webhook which it creates, or is it for creating a webhook that is somehow used by a different resource?

In other words, it doesn't seem clear whether this is a resource that you can use to kick off a pipeline based on github or whether this is a tool for maintaining such things.

GavinFigueroa commented 4 years ago

The description is definitely a low point of the README.

I'm curious to hear your feedback on an improvement. Would something short like Manages webhook configurations on GitHub.com and GitHub Enterprise deployments. be clear to you?

ghost commented 4 years ago

I'm still not sure what it does tbh.

If it doesn't respond to the webhooks to kick off builds but just makes the web lhooks I would call that out specifically as a warning and provide guidance on what other resources are necessary to acheive the goal of making a concourse pipeline immediately respond to changes in git.

On Thu, Dec 19, 2019, 5:01 PM GavinFigueroa notifications@github.com wrote:

The description is definitely a low point of the README.

I'm curious to hear your feedback on an improvement. Would something short like Manages webhook configurations on GitHub.com and GitHub Enterprise deployments. be clear to you?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_homedepot_github-2Dwebhook-2Dresource_issues_18-3Femail-5Fsource-3Dnotifications-26email-5Ftoken-3DANYDYN2UTEJ72DFBX3F52QLQZQKPFA5CNFSM4J5K3KY2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEHLRHBI-23issuecomment-2D567743365&d=DwMCaQ&c=NxS7LVD4EucgUR9_G6bWzuqhmQ0xEJ2AZdqjz4WaSHU&r=Qa9WLHzRP0MepP2a4OkA1hk-W78HNUjQ2hkhkH_2fZU&m=xHseo5L_KNc07mTUBm4R_rDrOPMHMWTR8LJBVfwW_Ss&s=lGSf5iFeO8Uj5hJ73r8DviPhLfc4ouONaEBaIaFiJog&e=, or unsubscribe https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_notifications_unsubscribe-2Dauth_ANYDYN474KQ7CDAGRP6Q3PTQZQKPFANCNFSM4J5K3KYQ&d=DwMCaQ&c=NxS7LVD4EucgUR9_G6bWzuqhmQ0xEJ2AZdqjz4WaSHU&r=Qa9WLHzRP0MepP2a4OkA1hk-W78HNUjQ2hkhkH_2fZU&m=xHseo5L_KNc07mTUBm4R_rDrOPMHMWTR8LJBVfwW_Ss&s=rKVahcNIAnQiSKB3nKN3E6JpzeQdswj7H8gSSHNT__w&e= .

-- This message may contain confidential and/or privileged information.  If you are not the addressee or authorized to receive this on behalf of the addressee you must not use, copy, disclose or take action based on this message or any information herein.  If you have received this message in error, please advise the sender immediately by reply email and delete this message. Thank you.

dkowis commented 3 years ago

It would also be nice to describe how the webhooks flow back in, architecturally, so if you're building a cluster of these things, you can set up the proper network routing and such.

isaacsanders commented 2 years ago

@ghost You can use it to re-check resources via the webhook provided by every resource type: https://concourse-ci.org/resources.html#resource-webhook-token

isaacsanders commented 2 years ago

Oh, I guess that user is gone