Add Deployments
preprocessor to forge doc
#5092
Merged
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.
Overview
Adds a new preprocessor / flag to
forge doc
that allows for generating deployment documentation fromhardhat-deploy
orforge-deploy
artifacts.Usage
If there is a
deployments
artifact directory present fromforge-deploy
orhardhat-deploy
, pass the--deployments / -d
flag toforge doc
to add a deployment table to all contracts with deployment artifacts.