Skip to content

Commit

Permalink
[Docs] troubleshooting step uses error (#14684)
Browse files Browse the repository at this point in the history
* add step uses error resolution

* add github sync troubleshooting redirect

* edits

* fix deleted part
  • Loading branch information
andrewjschuang authored Nov 19, 2024
1 parent 263d42e commit 9cbf1c2
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs-v2/pages/projects/git.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,21 @@ 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.

### 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 privately, the correct component key should be formatted as `@workspacename/component-key@version` (e.g., `@pipedream/[email protected]`).

To resolve this error:

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.

### 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)

Expand Down
4 changes: 4 additions & 0 deletions docs-v2/pages/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 9cbf1c2

Please sign in to comment.