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.

Sign up for GitHub

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

Jump to bottom

refactor: quality of life improvements #1006

Merged
merged 50 commits into from
Jan 31, 2025
Merged

refactor: quality of life improvements #1006

merged 50 commits into from
Jan 31, 2025

Conversation

0xClandestine
Copy link
Member

@0xClandestine 0xClandestine commented Jan 9, 2025 •
edited
Loading

Motivation:

This change consolidates our development infrastructure to make it more maintainable. Currently, we have:

  • Multiple overlapping GitHub workflows, making CI/CD harder to maintain.
  • Several outdated testing tools and scripts.
  • No standardized PR template.

Modifications:

  1. CI/CD Changes:

    • Consolidated GitHub workflows into three main files:
      • certora.yml for formal verification (commented out until certora finishes specs).
      • checks.yml for linting and bindings.
      • foundry.yml for testing (unit, integration, forked integration, storage, coverage).

  2. Project Structure:

    • Moved scripts to the bin/ directory.
    • Relocated CONTRIBUTING.md to .github/.
    • Overhauled CONTRIBUTING.md.
    • Added a PR template.
    • Removed unnecessary dotfiles.

  3. Testing:

    • Added DeployFromScratch.t.sol.
    • Removed unused test helpers.
    • Updated test configurations in foundry.toml.

Result:

These changes will:

  • Simplify CI pipeline maintenance.
  • Clarify the PR process with templates.
  • Remove unused code.
  • Update dependency paths.
  • Improve project organization.

@0xClandestine 0xClandestine changed the base branch from slashing-magnitudes to slashing-magnitudes-fixes January 14, 2025 19:26
@0xClandestine 0xClandestine changed the base branch from slashing-magnitudes-fixes to dev January 29, 2025 22:58
@0xClandestine 0xClandestine force-pushed the refactor/ci branch 2 times, most recently from 33be343 to 20d90d6 Compare January 29, 2025 23:41
@0xClandestine
Copy link
Member Author

0xClandestine commented Jan 30, 2025 •
edited
Loading

Working towards better handing in the Forge / Test (Storage) workflow...

NOTE: CI fuzz runs is currently set to 1 in foundry.toml for CI testing purposes.

NOTE: Commenting out certora workflow until they finish slashing specs.

ypatil12
ypatil12 reviewed Jan 30, 2025
View reviewed changes
Copy link
Collaborator

@ypatil12 ypatil12 left a comment

Choose a reason for hiding this comment

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

First pass, going to hold off on approving till the Fuzz runs are updated

@0xClandestine 0xClandestine changed the title refactor: ci refactor: Quality of Life Improvements Jan 30, 2025
0xrajath
0xrajath reviewed Jan 31, 2025
View reviewed changes
@0xClandestine
refactor: ci
cb86f3c 
refactor: remove gas report

fix: gas report

fix: gas report

refactor: continuous fuzzing

refactor: cleanup

feat: gas reporting

feat: intense continuous fuzzing

refactor: rename workflow files

refactor: renaming

refactor: ci

refactor: renaming

refactor: ci

feat: add `FOUNDRY_PROFILE=lite` to ci

refactor: small `foundry.toml` cleanup

refactor: renaming

fix: continuous fuzzing
@0xClandestine
refactor: naming
111c9d0
@0xClandestine
refactor: intense runs -> 15000
a3305be
@0xClandestine
refactor: move CONTRIBUTING.md -> .github/
b0f09d4
@0xClandestine
refactor: reduce dotfiles
89e0633
@0xClandestine
refactor: remove testHelpers
19e8080
@0xClandestine
feat: add PULL_REQUEST_TEMPLATE.md
749b087
@0xClandestine
refactor: foundry ci
341bb4c
@0xClandestine
fix: foundry ci
0ed3204
@0xClandestine
refactor: rename
ac2cd22
0xrajath
0xrajath approved these changes Jan 31, 2025
View reviewed changes
Copy link
Contributor

@0xrajath 0xrajath left a comment

Choose a reason for hiding this comment

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

LGTM. I would wait for the CI checks to pass before merging.

@ypatil12 ypatil12 changed the title refactor: Quality of Life Improvements refactor: quality of life improvements Jan 31, 2025
@0xClandestine 0xClandestine merged commit 6caf5cc into dev Jan 31, 2025
3 of 6 checks passed
@0xClandestine 0xClandestine deleted the refactor/ci branch January 31, 2025 18:54
ypatil12 pushed a commit that referenced this pull request Feb 19, 2025
@0xClandestine @ypatil12
refactor: quality of life improvements (#1006)
7d63aea 
* refactor: ci

refactor: remove gas report

fix: gas report

fix: gas report

refactor: continuous fuzzing

refactor: cleanup

feat: gas reporting

feat: intense continuous fuzzing

refactor: rename workflow files

refactor: renaming

refactor: ci

refactor: renaming

refactor: ci

feat: add `FOUNDRY_PROFILE=lite` to ci

refactor: small `foundry.toml` cleanup

refactor: renaming

fix: continuous fuzzing

* refactor: naming

* refactor: intense runs -> 15000

* refactor: move CONTRIBUTING.md -> .github/

* refactor: reduce dotfiles

* refactor: remove `testHelpers`

* feat: add `PULL_REQUEST_TEMPLATE.md`

* refactor: foundry ci

* fix: foundry ci

* refactor: rename

* feat: mainnet storage diff ci

* refactor: certora ci (remove parallelism)

* refactor: intense runs -> 5000

* refactor: coverage

* test: ci

* refactor: continuous fuzzing

* refactor: note minimum avg coverage

* refactor: coverage

* refactor: coverage

* refactor: coverage

* refactor: coverage

* refactor: coverage

* refactor: coverage

* refactor: move storage-diff.yml

* refactor: foundry.yml

* refactor: foundry.yml

* fix: certora scripts

* fix: certora

* refactor: local deploy workflow -> test

* refactor: rename certora workflow

* refactor: checks

* refactor: name

* refactor: comment out certora.yml until they finish slashing specs

* refactor: review changes

* refactor: ci runs 1 -> 256

* fix: coverage branch filtering

* refactor: add -vvv flag

* refactor: lowercase pr template name

* refactor: move CONTRIBUTING.md

* feat: more storage diff coverage

* docs: improve contributor guide

* refactor: intense workflow

- add message telling the dev it's purpose

* refactor: intense warning

* refactor: add `.github/configs/`

* fix: ci

* refactor: remove useless commitlint config

* refactor: cleanup

* refactor: add color

* refactor: remove useless color flag

* refactor: remove prettier (unused)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ypatil12 ypatil12 ypatil12 approved these changes

@0xrajath 0xrajath 0xrajath approved these changes

@nadir-akhtar nadir-akhtar Awaiting requested review from nadir-akhtar

@8sunyuan 8sunyuan Awaiting requested review from 8sunyuan

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@0xClandestine @0xrajath @ypatil12