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

Add referenceBuildInfoDir and exclude options #74

Merged
merged 24 commits into from
Sep 24, 2024

Conversation

ericglau
Copy link
Member

@ericglau ericglau commented Sep 12, 2024

Fixes #56

Adds options to make use of OpenZeppelin/openzeppelin-upgrades#1062 and OpenZeppelin/openzeppelin-upgrades#1065

  • Adds referenceBuildInfoDir option which takes the path to an older build info directory, which can contain the previous version of a contract to use as a reference for storage layout comparisons
    • When this is provided, that older build info directory should be referenced in the @custom:oz-upgrades-from annotation or using the referenceContract option, for example by using: build-info-v1/MyContract
  • Adds exclude option which takes a string array of glob patterns, from which to exclude contracts from validations
  • Updated and reorganized documentation

@ericglau ericglau marked this pull request as ready for review September 12, 2024 21:32
@ericglau ericglau requested a review from a team September 12, 2024 21:32
@ericglau ericglau merged commit 16e0ae2 into OpenZeppelin:main Sep 24, 2024
3 checks passed
@ericglau ericglau deleted the newoptions branch September 24, 2024 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

How to Upgrade without Changing Name or Creating New Contract ?
2 participants