Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): add instructions in how to find binaries path #303

Merged
merged 1 commit into from
Dec 19, 2023

Conversation

yj-yan
Copy link
Contributor

@yj-yan yj-yan commented Dec 19, 2023

Please read CONTRIBUTING.md for additional information on contributing to this repository!

What this PR does / why we need it

Address the comment for merged PR. (#302 (comment))

Jira ID

[XX-XX]

Notes for your reviewers

@yj-yan yj-yan requested a review from a team as a code owner December 19, 2023 23:14
Copy link

netlify bot commented Dec 19, 2023

Deploy Preview for engineering-outreach-io-stencil ready!

Name Link
🔨 Latest commit 404876e
🔍 Latest deploy log https://app.netlify.com/sites/engineering-outreach-io-stencil/deploys/658223c7e01e090008744a2f
😎 Deploy Preview https://deploy-preview-303--engineering-outreach-io-stencil.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@yj-yan yj-yan merged commit b792fce into main Dec 19, 2023
9 checks passed
@yj-yan yj-yan deleted the yjyan/native-extension-docs branch December 19, 2023 23:19
@@ -31,7 +31,8 @@ A native extension can be ran locally using the `replacements` key in an applica

## Debugging a Native Extension

The [`go-plugin`](https://github.com/hashicorp/go-plugin) library does not surface errors to stencil. Instead, it will raise the generic message `failed to create connection to extension: Unrecognized remote plugin message`. To determine a more precise error message, execute the native extension binary directly.
The [`go-plugin`](https://github.com/hashicorp/go-plugin) library does not surface errors to stencil. Instead, it will raise the generic message `failed to create connection to extension: Unrecognized remote plugin message`. The binary path could be found in bottom of the returned error. To determine a more precise error message, execute the native extension binary directly. Normally the binary lives in the `bin/plugin` in the native extension direcotry.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: verb tense and reordering

Suggested change
The [`go-plugin`](https://github.com/hashicorp/go-plugin) library does not surface errors to stencil. Instead, it will raise the generic message `failed to create connection to extension: Unrecognized remote plugin message`. The binary path could be found in bottom of the returned error. To determine a more precise error message, execute the native extension binary directly. Normally the binary lives in the `bin/plugin` in the native extension direcotry.
The [`go-plugin`](https://github.com/hashicorp/go-plugin) library does not surface errors to stencil. Instead, it will raise the generic message `failed to create connection to extension: Unrecognized remote plugin message`. To determine a more precise error message, execute the native extension binary directly. The binary path can usually be found in bottom of the returned error. If not, the binary lives in the `bin/plugin` subdirectory of the native extension folder.

@yj-yan yj-yan mentioned this pull request Dec 19, 2023
@getoutreach-ci-1
Copy link
Contributor

🎉 This PR is included in version 1.37.2-rc.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@getoutreach-ci-2
Copy link

🎉 This PR is included in version 1.37.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants