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

maint(ci): remove autogenerated invariant docs #11988

Merged
merged 1 commit into from
Sep 19, 2024
Merged

Conversation

smartcontracts
Copy link
Contributor

Removes autogenerated invariant docs from the contracts package. These autogenerated docs create confusion about where invariants should be defined (the answer is in the specs) and no one actually looks at them anyway. Just adds an additional step into CI for minimal benefit.

Closes #11251

@smartcontracts
Copy link
Contributor Author

Pending comments from Wonderland

Removes autogenerated invariant docs from the contracts package.
These autogenerated docs create confusion about where invariants
should be defined (the answer is in the specs) and no one actually
looks at them anyway. Just adds an additional step into CI for
minimal benefit.
Copy link

codecov bot commented Sep 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.87%. Comparing base (a1f912a) to head (8b9b9f8).
Report is 3 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop   #11988      +/-   ##
===========================================
- Coverage    79.10%   78.87%   -0.24%     
===========================================
  Files           41       41              
  Lines         3437     3437              
===========================================
- Hits          2719     2711       -8     
- Misses         548      557       +9     
+ Partials       170      169       -1     
Flag Coverage Δ
cannon-go-tests 78.87% <ø> (-0.24%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes

@tynes tynes added this pull request to the merge queue Sep 19, 2024
Merged via the queue into develop with commit 45a266e Sep 19, 2024
65 checks passed
@tynes tynes deleted the sc/ci-no-invariant-docs branch September 19, 2024 23:20
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.

EVM Engineering: remove autogenerated invariant docs
4 participants