Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for Hardhat task actions returning a Result, and links this concept from the plugin lifecycle docs to the task-writing guide. This supports Hardhat 3 users/plugin authors who want to signal task failure via exit codes without throwing.
Changes:
- Add a “Returning a result” section to the task actions lifecycle documentation.
- Add a “Returning a result” section (with a TypeScript example) to the Writing Hardhat tasks guide.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/content/docs/docs/plugin-development/explanations/lifecycle.mdx | Introduces a short “Returning a result” subsection and links to the tasks guide for details. |
| src/content/docs/docs/guides/writing-tasks.mdx | Adds a new guide section explaining Result, helper functions, and CLI exit code behavior, including an example. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
alcuadrado
reviewed
Mar 2, 2026
alcuadrado
reviewed
Mar 2, 2026
| - `{ success: true; value: ValueT }` - a successful result, optionally carrying a value | ||
| - `{ success: false; error: ErrorT }` - a failed result, optionally carrying error information | ||
|
|
||
| Use `successfulResult(value?)` and `errorResult(error?)` to create these objects. Both success and failure cases can carry data. This is useful when you want to return context regardless of the outcome, such as a test run summary. |
Member
There was a problem hiding this comment.
Same here, I wouldn't say that value and error are optional.
alcuadrado
approved these changes
Mar 2, 2026
Member
alcuadrado
left a comment
alcuadrado
left a comment
There was a problem hiding this comment.
I left a few comments, but looks good
Co-authored-by: Patricio Palladino <patricio@nomic.foundation> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs for NomicFoundation/hardhat#8012