From cdf816a31e217a6fe16b5f44f40e372423a70186 Mon Sep 17 00:00:00 2001 From: Andrew Chuang Date: Tue, 19 Nov 2024 10:55:24 -0300 Subject: [PATCH 1/4] add step uses error resolution --- docs-v2/pages/projects/git.mdx | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs-v2/pages/projects/git.mdx b/docs-v2/pages/projects/git.mdx index 3de53a1a346d0..cbdf7f61350b4 100644 --- a/docs-v2/pages/projects/git.mdx +++ b/docs-v2/pages/projects/git.mdx @@ -198,6 +198,18 @@ Yes, you can use the GitHub Syncing feature to develop your workflows from YAML Then pushing changes to the `production` branch will trigger a deploy for your Pipedream workflows. +### How can I fix the error about "could not resolve step[index].uses: component-key@version": +When you publish a private component to your workspace and reference it in a workflow, the workspace name should be prefixed in the component key in your `workflow.yaml` configuration file. + +For example, if you modified a [registry action](https://pipedream.com/docs/apps/contributing) and published it to your workspace, the correct component key is `@workspacename/component-key@version` (e.g. `@pipedream/github-update-issue@0.1.0`). + +1. Clone your repository locally and create a dev branch. +2. Find the line of the error and add the workspace name prefix to the component key. +3. Commmit your change and push it. +4. Open your project in the Pipedream UI, select your dev branch. +5. Click on Merge to Production and verify if the workflow deployment was successful in the [Changelog](https://pipedream.com/docs/projects/git#use-the-changelog). +6. If you need further help, [reach out to support](https://pipedream.com/support). + ### Why am I seeing an error about "private auth mismatch" when trying to merge a branch to production? ![Private Auth Mismatch](https://res.cloudinary.com/pipedreamin/image/upload/v1704258143/private_auth_mismatch_kzdd7e.png) From d8482b8cee478e32a4c5f7033a28644ca36d2d76 Mon Sep 17 00:00:00 2001 From: Andrew Chuang Date: Tue, 19 Nov 2024 10:57:32 -0300 Subject: [PATCH 2/4] add github sync troubleshooting redirect --- docs-v2/pages/troubleshooting.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs-v2/pages/troubleshooting.mdx b/docs-v2/pages/troubleshooting.mdx index b8d54c1d8ae9b..d6b3760c899fd 100644 --- a/docs-v2/pages/troubleshooting.mdx +++ b/docs-v2/pages/troubleshooting.mdx @@ -30,6 +30,10 @@ If you're encountering a specific issue in a workflow, try the following steps, If you're still seeing the issue after trying these steps, please reach out in [the community](https://pipedream.com/support). +## I need help with my GitHub Synced Project + +[See FAQ here](https://pipedream.com/docs/projects/git#frequently-asked-questions). + ## Why is my trigger not emitting events? Most Pipedream sources fall into one of two categories: webhook-based or timer-based. From 88b8e1a79fefe1340e9e3e3edd91d3057084d3c2 Mon Sep 17 00:00:00 2001 From: Andrew Chuang Date: Tue, 19 Nov 2024 11:13:51 -0300 Subject: [PATCH 3/4] edits --- docs-v2/pages/projects/git.mdx | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs-v2/pages/projects/git.mdx b/docs-v2/pages/projects/git.mdx index cbdf7f61350b4..10a9c2c58e6b5 100644 --- a/docs-v2/pages/projects/git.mdx +++ b/docs-v2/pages/projects/git.mdx @@ -198,20 +198,20 @@ Yes, you can use the GitHub Syncing feature to develop your workflows from YAML Then pushing changes to the `production` branch will trigger a deploy for your Pipedream workflows. -### How can I fix the error about "could not resolve step[index].uses: component-key@version": -When you publish a private component to your workspace and reference it in a workflow, the workspace name should be prefixed in the component key in your `workflow.yaml` configuration file. +### Why am I seeing the error "could not resolve step[index].uses: component-key@version" when merging to production? +This error occurs when a workflow references a [private component](https://pipedream.com/docs/components#using-private-actions) without properly prefixing the component key with your workspace name in the `workflow.yaml` configuration file. Pipedream requires this prefix to correctly identify and resolve components specific to your workspace. -For example, if you modified a [registry action](https://pipedream.com/docs/apps/contributing) and published it to your workspace, the correct component key is `@workspacename/component-key@version` (e.g. `@pipedream/github-update-issue@0.1.0`). +For example, if you modified a [registry action](https://pipedream.com/docs/apps/contributing) and published it privately, the correct component key should be formatted as `@workspacename/component-key@version` (e.g., `@pipedream/github-update-issue@0.1.0`). -1. Clone your repository locally and create a dev branch. -2. Find the line of the error and add the workspace name prefix to the component key. -3. Commmit your change and push it. -4. Open your project in the Pipedream UI, select your dev branch. -5. Click on Merge to Production and verify if the workflow deployment was successful in the [Changelog](https://pipedream.com/docs/projects/git#use-the-changelog). -6. If you need further help, [reach out to support](https://pipedream.com/support). +To resolve this error: -### Why am I seeing an error about "private auth mismatch" when trying to merge a branch to production? -![Private Auth Mismatch](https://res.cloudinary.com/pipedreamin/image/upload/v1704258143/private_auth_mismatch_kzdd7e.png) +1. Clone your repository locally and create a development branch. +2. Locate the error in your `workflow.yaml` file where the component key is specified. +3. Add your workspace name prefix to the component key, ensuring it follows the format `@workspacename/component-key@version`. +4. Commit your changes and push them to your repository. +5. Open your project in the Pipedream UI and select your development branch. +6. Click on **Merge to Production** and verify the deployment success in the [Changelog](https://pipedream.com/docs/projects/git#use-the-changelog). +7. If the issue persists, [reach out to Pipedream Support](https://pipedream.com/support) for further assistance. This error occurs when **both** of the below conditions are met: 1. The referenced workflow is using a connected account that's not shared with the entire workspace From eebc66fa7a629f6bfdc818db2ba7484b6e1bc64e Mon Sep 17 00:00:00 2001 From: Andrew Chuang Date: Tue, 19 Nov 2024 11:20:38 -0300 Subject: [PATCH 4/4] fix deleted part --- docs-v2/pages/projects/git.mdx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs-v2/pages/projects/git.mdx b/docs-v2/pages/projects/git.mdx index 10a9c2c58e6b5..a92e66d921fe0 100644 --- a/docs-v2/pages/projects/git.mdx +++ b/docs-v2/pages/projects/git.mdx @@ -213,6 +213,9 @@ To resolve this error: 6. Click on **Merge to Production** and verify the deployment success in the [Changelog](https://pipedream.com/docs/projects/git#use-the-changelog). 7. If the issue persists, [reach out to Pipedream Support](https://pipedream.com/support) for further assistance. +### Why am I seeing an error about "private auth mismatch" when trying to merge a branch to production? +![Private Auth Mismatch](https://res.cloudinary.com/pipedreamin/image/upload/v1704258143/private_auth_mismatch_kzdd7e.png) + This error occurs when **both** of the below conditions are met: 1. The referenced workflow is using a connected account that's not shared with the entire workspace 2. The change was merged from outside the Pipedream UI (via github.com or locally)