This topic was automatically generated from Slack. You can find the original thread here.
how do i publish an integration/app into public pipedream? any resources on the workflow for that?
To publish an integration (app) to the public Pipedream platform, you’ll want to contribute your triggers and actions as Pipedream components. Here’s a step-by-step overview of the process, along with resources to guide you: ## Contribution Process 1. Fork the Pipedream Registry Repo Fork the public Pipedream Registry Github Repository. 2. Create Your Component - Add your new component (trigger or action) in the appropriate app directory within the components folder. - Follow best practices from the Component Guidelines & Patterns. 3. Submit a Pull Request - Create a PR for the Pipedream team to review. - Address any feedback provided by the team. 4. Approval and Merge - Once approved, your component will be merged to the master branch. - It will then be available for all Pipedream users! ## Resources - Component Contribution Docs - Component Guidelines & Patterns - Pipedream Registry GitHub ## Additional Notes - If you want to integrate a new app and want Pipedream to build the initial integration, you can also submit an integration request. - For more details on the integration process, see the Pipedream Apps Integration Process. If you have any questions or run into issues, you can always reach out to the Pipedream team or visit Pipedream for more support options.
is there a way to publish the app privately, or have it tested? I feel like there should be a way to test it privately before merging it into the public repository.
Currently, Pipedream does not support publishing integrations (apps/components) privately for use only within your account or organization. All custom integrations that you want to share with the public must be contributed to the Pipedream public registry via a pull request. Testing your integration before public release: - Local Development: You can develop and test your Pipedream components locally using GitHub sync. This allows you to edit your code in your local environment or in a development branch on GitHub. - Commit and push your local changes to a development branch. - Open your project in the Pipedream UI and load your development branch. - Use the Git Actions menu to pull changes from GitHub and test them in your own workflows before submitting a PR. - See the Local development docs for more details. - No Private Publishing: There is currently no way to publish an app privately for just your account or workspace, nor is there a built-in unit testing framework for components (see docs). All custom apps/components must be merged into the public repo to be available to everyone. Summary: - You can test integrations locally or in a private GitHub branch before submitting them for public release. - There is no private publishing option at this time. - If you need more advanced or private testing features, or want to request them, you can reach out to Pipedream support at Pipedream. Let me know if you need more details on the local development workflow!
but this means we can dev locally and test properly before publishing right? How can i do that?
Yes, you can develop and test Pipedream components (apps, triggers, actions) locally before publishing them publicly. Here’s how you can do that: ## Local Development and Testing Workflow 1. Develop Locally - Use your preferred code editor (like VSCode) to write your Pipedream component code. - Keep your code in your own GitHub repo for version control. 2. Deploy or Publish Locally - Use the Pipedream CLI to deploy your source (trigger) components directly from your local code, or publish them to your account. - Actions may only be published (not directly deployed), but once published, you can add them to your own workflows for testing. 3. Test in Your Account - Published components are only available to your own account by default. This means you can add them to your workflows and test them privately before making them public. - If you publish to a team account, any member of the team can discover and test the component. 4. Iterate and Update - Make changes locally, commit and push to your repo, and redeploy or republish as needed. - Test each version in your Pipedream account until you’re satisfied. 5. Publish Publicly (Optional) - Once your component is ready, you can submit it for public inclusion in the Pipedream registry. ## References from Pipedream Docs - You can develop components locally and publish them to your account for private use and testing. - GitHub Sync allows you to edit workflows and components locally, push changes to a development branch, and pull them into Pipedream for testing. ## Summary - Yes, you can develop and test components locally and privately in your own account before publishing them publicly. - Use the Pipedream CLI and GitHub Sync to manage your workflow. - Only when you’re ready do you need to submit your component for public listing. If you need more details or run into issues, you can always visit Pipedream for more support options.
Would that local testing be in the form of an app like when it gets published? Or is it just under the “My Actions” section of the workspace and account?
When you develop and test Pipedream components (apps, triggers, actions) locally and publish them using the CLI, they appear in your account under the “My Actions” or “My Sources” section of the Pipedream UI—not as a public app in the main registry. - Local testing: You can run and test your component in your own account or workspace before publishing it publicly. - Visibility: These components are only visible to you (or your team, if published to a team account) and are not available to other Pipedream users. - Experience: The testing experience is very similar to how it will work once published publicly, but the component is scoped to your account. You can add it to workflows, configure props, and run/test it just like a public action/trigger. Summary: Local/private components appear under “My Actions” or “My Sources” in your workspace, not as a public app. This lets you test them as if they were published, but only you (or your team) can see and use them until you publish them publicly. If you need more help or run into issues, please visit Pipedream.
how do i test the credentials to a “connected account” for my app without publishing it to public pipedream?
You can test the credentials to a “connected account” for your app privately, without publishing it to the public Pipedream registry. Here’s how you can do this: — ### How to Test Connected Account Credentials Privately 1. Develop your app/component locally - Build your Pipedream app, action, or trigger using the Pipedream component format. - Use the Pipedream CLI to publish your component to your own account or workspace. It will appear under “My Actions” or “My Sources” and is only visible to you (or your team). 2. Connect a test account in development mode - In your Pipedream project, go to the Users tab. - Click Connect account and go through the OAuth or credential flow. - Make sure to create the account in development mode (not production). - After connecting, you’ll have a test connected account you can use in your private component. See the official docs for connecting a test account 3. Test your component with the connected account - In your workflow, add your private component. - When configuring the step, select the test connected account you just created. - Run the workflow to verify that your component can access the credentials and make authenticated API requests. — Summary: You do NOT need to publish your app publicly to test connected account credentials. Just connect a test account in development mode and use it with your private component in your workspace. If you have any issues or need more help, please visit Pipedream.