Add sources for DeployHQ

[jmsfwk]

Related to #4319

Sources

• Deploy Started | Emit new events when deploys start
• Deploy Complete | Emit new events when deploys complete
• Deploy Failed | Emit new events when deploys fail

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
pipedream-docs	✅ Ready (Inspect)	Visit Preview	Oct 10, 2022 at 8:44AM (UTC)
pipedream-docs-redirect-do-not-edit	✅ Ready (Inspect)	Visit Preview	Oct 10, 2022 at 8:44AM (UTC)

[dylburger]

Thank you so much for submitting this! We've added it to our backlog to review, and our team has been notified.

[dylburger]

Thanks for submitting this PR! When we review PRs, we follow the Pipedream component guidelines. If you're not familiar, here's a quick checklist:

• [ ] Create components to address specific use cases whenever possible
• [ ] Component keys should follow the format app_name_slug-slugified-component-name
• [ ] Components should follow the standard directory structure
• [ ] Prefer Node.js client libraries to REST APIs
• [ ] When making API requests, handle pagination to ensure all data / events are processed
• [ ] Use secret props to capture sensitive data
• [ ] Props and methods should be defined in app files whenever possible
• [ ] Document methods with JS Docs
• [ ] Use optional props whenever possible, and set a default value where you can
• [ ] Use async options to accept user input wherever possible
• [ ] Create subscription webhooks sources (vs polling sources) whenever possible
• [ ] Always emit a summary with events
• [ ] Use a built-in deduping strategy wherever possible
• [ ] When building webhook sources, follow these best practices
• [ ] When building polling sources, follow these best practices

[vunguyenhung]

@andrewjschuang @dannyroosevelt I think we can wait for the ticket to integrate this App to Pipedream first, then merge this PR if there's no conflict?

[dannyroosevelt]

@vunguyenhung @andrewjschuang sorry for the delay, this is done -- https://github.com/PipedreamHQ/pipedream/tree/master/components/deployhq/app

[vunguyenhung]

Thank you @dannyroosevelt! Hello @jmsfwk could you resolve the conflicts so we can proceed to test and merge this?

[vunguyenhung]

I have resolved the conflict, QAing this now 🙏

[ghost]

when i published the sources all 3 of them didn’t showed any prop to select account

all 3 of them didn’t even showed up any logs as well

when i tried to send a sample event it showed this error in the logs (remember firstly there were no logs out there)

all of them showed the same error so i only shared the one screenshot for each error devs please ping me if you are facing any issue reproducing errors

[jmsfwk]

The sources don't need to select an account. DeployHQ doesn't provide a mechanism to manage webhooks so there's no need one.

The error is what I'd expect when sending a request without a signature. I could catch that and provide a more user friendly message?

[vunguyenhung]

Hello @jmsfwk, could you advice as a user how can we add the signature to the request? From the user point of view, how can we use this source?

[jmsfwk]

Hello @jmsfwk, could you advice as a user how can we add the signature to the request? From the user point of view, how can we use this source?

It's not possible to add the signature to the request because it's generated with DeployHQ's private key.

From a users perspective they will have to:

1. Create the source
2. Copy the endpoint and create a new integration through the DeployHQ interface (because there is no API endpoint to manage integrations)
3. Requests will be sent to the endpoint and the source will emit events

[dannyroosevelt]

Hello @jmsfwk, could you advice as a user how can we add the signature to the request? From the user point of view, how can we use this source?

It's not possible to add the signature to the request because it's generated with DeployHQ's private key.

From a users perspective they will have to:

1. Create the source
2. Copy the endpoint and create a new integration through the DeployHQ interface (because there is no API endpoint to manage integrations)
3. Requests will be sent to the endpoint and the source will emit events

Hello @jmsfwk, could you advice as a user how can we add the signature to the request? From the user point of view, how can we use this source?

It's not possible to add the signature to the request because it's generated with DeployHQ's private key.

From a users perspective they will have to:

1. Create the source
2. Copy the endpoint and create a new integration through the DeployHQ interface (because there is no API endpoint to manage integrations)
3. Requests will be sent to the endpoint and the source will emit events

Since we aren't able to register webhooks programmatically, should we implement the sources as polling on relevant GET endpoints?

[jmsfwk]

I'd prefer the hassle of manually setting up the webhook to have immediate notifications.

But I'd be happy to create a polling source if you think it's needed.

[dannyroosevelt]

I'd prefer the hassle of manually setting up the webhook to have immediate notifications.

But I'd be happy to create a polling source if you think it's needed.

We could add some info to the app's page in our marketplace instructing users how to manually create webhooks and configure in DeployHQ -- what do you think of that?

[jmsfwk]

We could add some info to the app's page in our marketplace instructing users how to manually create webhooks and configure in DeployHQ -- what do you think of that?

That is a good idea.

[dannyroosevelt]

We could add some info to the app's page in our marketplace instructing users how to manually create webhooks and configure in DeployHQ -- what do you think of that?

That is a good idea.

Do you want to take a crack at writing those instructions? You can add a README.md file to the app's root directory in /components, and we'll render that here: https://pipedream.com/apps/deployhq

We give special treatment to H1 elements for "Overview", "Getting Started", and "Troubleshooting".

Here is an example: https://github.com/PipedreamHQ/pipedream/blob/master/components/gmail/README.md

[jmsfwk]

@dannyroosevelt Is the readme I added acceptable?

[dannyroosevelt]

@dannyroosevelt Is the readme I added acceptable?

Looks great! Was there anything else pending, or are we good to merge and publish?

[jmsfwk]

Good with me thank you

[dannyroosevelt]

@jcortes can you fix the version warning and the linting error? And I added it to QA's queue.

[vunguyenhung]

Hi @jmsfwk, I followed your description and verified these sources. Just bump up the version in package.json then this is ready for merging and release!

Test report DeployHQ_4320.pdf

[vunguyenhung]

Hello @michelle0927, as you're the current PR reviewer, could you help @jmsfwk to fix the failed checks and approve the PR? Thank you so much 🙏

On another note, I think if @jmsfwk is not responsive for now then we can merge this PR and make another PR to bump up the version in the components/deployhq/package.json.

[alysonturing]

I'll close this PR in favor of #4572 which I picked from the Fork