From 4476d6673fdc0f0c02a1666b8dc64608d7f14b4b Mon Sep 17 00:00:00 2001 From: SidestreamColdMelon Date: Thu, 21 Nov 2024 15:00:22 +0100 Subject: [PATCH 1/6] document foundry versions --- spell/spell-crafter-mainnet-workflow.md | 13 +++++++++++-- spell/spell-reviewer-mainnet-checklist.md | 13 ++++++++++++- 2 files changed, 23 insertions(+), 3 deletions(-) diff --git a/spell/spell-crafter-mainnet-workflow.md b/spell/spell-crafter-mainnet-workflow.md index c507146..9bd3405 100644 --- a/spell/spell-crafter-mainnet-workflow.md +++ b/spell/spell-crafter-mainnet-workflow.md @@ -34,6 +34,13 @@ Repo: https://github.com/makerdao/spells-mainnet ## Development Stage +* Install stable foundry version + * [ ] Find the first [foundry release](https://github.com/foundry-rs/foundry/releases) that is older than 7 days from now + * [ ] Insert release URL here: + * [ ] Install specified version via `foundryup --version git_tag_name` + ``` + Document relevant installation logs below + ``` * Create new branch * [ ] Pull `master` branch of the `spells-mainnet` repo locally * [ ] Create a new branch named `YYYY-MM-DD` using the _initial_ target date of the spell @@ -58,7 +65,6 @@ Repo: https://github.com/makerdao/spells-mainnet * [ ] Keep all tests that are already skipped (e.g. `testOSMs`, `testMedianizers`) * [ ] Remove unused interface declarations * Ensure correctness of the cleanup - * [ ] Ensure to use latest `foundry` stable version by running `foundryup` * [ ] Run Tests `make test` (or `make test match=` to inspect debug traces) * Add comments to the spell based on the relevant [Exec Sheet](https://docs.google.com/spreadsheets/d/1w_z5WpqxzwreCcaveB2Ye1PP5B8QAHDglzyxKHG3CHw) * [ ] Copy every _Section text_ from the Exec Sheet as comment to the spell code @@ -210,7 +216,10 @@ Repo: https://github.com/makerdao/spells-mainnet * [ ] Archive Spell via `make archive-spell` for the current date (or `make archive-spell date="YYYY-MM-DD"`) using Target Date inside the Exec Doc * [ ] Commit & push changes for review * [ ] Wait for CI to PASS -* [ ] Post a comment inside the PR containing links to the deployed spell and Tenderly Testnet +* [ ] Post a comment inside the PR containing + * Foundry installation logs (from the above) + * Link to the deployed spell + * Link to the created Tenderly Testnet * [ ] Notify the reviewers (e.g. "the spell was deployed") ## Handover and Merge Stage diff --git a/spell/spell-reviewer-mainnet-checklist.md b/spell/spell-reviewer-mainnet-checklist.md index 3b2a52b..f029d05 100644 --- a/spell/spell-reviewer-mainnet-checklist.md +++ b/spell/spell-reviewer-mainnet-checklist.md @@ -2,6 +2,13 @@ ## Development Stage +* Install stable foundry version + * [ ] Find the first [foundry release](https://github.com/foundry-rs/foundry/releases) that is older than 7 days from now + * [ ] Insert release URL here: + * [ ] Install specified version via `foundryup --version git_tag_name` + ``` + Document relevant installation logs below + ``` * Preparation * [ ] Exec Sheet for the specified date is found in the ["Executive Vote Implementation Process" google sheet](https://docs.google.com/spreadsheets/d/1w_z5WpqxzwreCcaveB2Ye1PP5B8QAHDglzyxKHG3CHw) _Insert URL to the specific sheet here_ @@ -29,7 +36,6 @@ * `// Forum:` if URL starts with `https://forum.makerdao.com/t/` * `// MIP:` if URL starts with `https://mips.makerdao.com/mips/details/` * Dependency checks - * [ ] Update Foundry by running `foundryup` * [ ] Reinstall libraries by running `rm -rf ./lib && git submodule update --init --recursive` ```bash Insert checked out submodule paths here @@ -364,6 +370,11 @@ _Insert your local test logs here_ ## Deployed Stage +* Comment in the PR + * [ ] Contains relevant foundry installation logs + * [ ] Contains URL to the deployed spell + * [ ] URL matches spell address declared in the `config.sol` + * [ ] Contains URL to the Tenderly Testnet * Source code settings * [ ] Deployed spell is verified on etherscan * [ ] Optimization enabled: `false` UNLESS the contract size is too big AND all mitigation strategies (i.e.: removing revert strings) have failed From 58a1817c64c2066b02b3edf0e3c0ddade710dc43 Mon Sep 17 00:00:00 2001 From: SidestreamColdMelon Date: Thu, 21 Nov 2024 17:54:04 +0100 Subject: [PATCH 2/6] fix grammar --- spell/spell-crafter-mainnet-workflow.md | 18 +++++++++--------- spell/spell-reviewer-mainnet-checklist.md | 20 ++++++++++---------- 2 files changed, 19 insertions(+), 19 deletions(-) diff --git a/spell/spell-crafter-mainnet-workflow.md b/spell/spell-crafter-mainnet-workflow.md index 9bd3405..fc2952e 100644 --- a/spell/spell-crafter-mainnet-workflow.md +++ b/spell/spell-crafter-mainnet-workflow.md @@ -34,12 +34,12 @@ Repo: https://github.com/makerdao/spells-mainnet ## Development Stage -* Install stable foundry version - * [ ] Find the first [foundry release](https://github.com/foundry-rs/foundry/releases) that is older than 7 days from now - * [ ] Insert release URL here: - * [ ] Install specified version via `foundryup --version git_tag_name` +* Install stable Foundry version + * [ ] Find the first [Foundry release](https://github.com/foundry-rs/foundry/releases) that is older than 7 days from now + * [ ] Insert the release URL here: + * [ ] Install the specified version via `foundryup --version git_tag_name` ``` - Document relevant installation logs below + Document the relevant installation logs below ``` * Create new branch * [ ] Pull `master` branch of the `spells-mainnet` repo locally @@ -216,10 +216,10 @@ Repo: https://github.com/makerdao/spells-mainnet * [ ] Archive Spell via `make archive-spell` for the current date (or `make archive-spell date="YYYY-MM-DD"`) using Target Date inside the Exec Doc * [ ] Commit & push changes for review * [ ] Wait for CI to PASS -* [ ] Post a comment inside the PR containing - * Foundry installation logs (from the above) - * Link to the deployed spell - * Link to the created Tenderly Testnet +* [ ] Post a comment inside the PR containing: + * Foundry installation logs (from above) + * A link to the deployed spell + * A link to the created Tenderly Testnet * [ ] Notify the reviewers (e.g. "the spell was deployed") ## Handover and Merge Stage diff --git a/spell/spell-reviewer-mainnet-checklist.md b/spell/spell-reviewer-mainnet-checklist.md index f029d05..bc8aa82 100644 --- a/spell/spell-reviewer-mainnet-checklist.md +++ b/spell/spell-reviewer-mainnet-checklist.md @@ -2,12 +2,12 @@ ## Development Stage -* Install stable foundry version - * [ ] Find the first [foundry release](https://github.com/foundry-rs/foundry/releases) that is older than 7 days from now - * [ ] Insert release URL here: - * [ ] Install specified version via `foundryup --version git_tag_name` +* Install stable Foundry version + * [ ] Find the first [Foundry release](https://github.com/foundry-rs/foundry/releases) that is older than 7 days from now + * [ ] Insert the release URL here: + * [ ] Install the specified version via `foundryup --version git_tag_name` ``` - Document relevant installation logs below + Document the relevant installation logs below ``` * Preparation * [ ] Exec Sheet for the specified date is found in the ["Executive Vote Implementation Process" google sheet](https://docs.google.com/spreadsheets/d/1w_z5WpqxzwreCcaveB2Ye1PP5B8QAHDglzyxKHG3CHw) @@ -370,11 +370,11 @@ _Insert your local test logs here_ ## Deployed Stage -* Comment in the PR - * [ ] Contains relevant foundry installation logs - * [ ] Contains URL to the deployed spell - * [ ] URL matches spell address declared in the `config.sol` - * [ ] Contains URL to the Tenderly Testnet +* Comment in the PR: + * [ ] Contains relevant Foundry installation logs + * [ ] Contains a URL to the deployed spell + * [ ] URL matches the spell address declared in `config.sol` + * [ ] Contains a URL to the Tenderly Testnet * Source code settings * [ ] Deployed spell is verified on etherscan * [ ] Optimization enabled: `false` UNLESS the contract size is too big AND all mitigation strategies (i.e.: removing revert strings) have failed From e4006697140c6d16bd9a66a0e58dc69b19253169 Mon Sep 17 00:00:00 2001 From: SidestreamColdMelon Date: Thu, 21 Nov 2024 17:56:26 +0100 Subject: [PATCH 3/6] add version command --- spell/spell-crafter-mainnet-workflow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spell/spell-crafter-mainnet-workflow.md b/spell/spell-crafter-mainnet-workflow.md index fc2952e..d17b2a9 100644 --- a/spell/spell-crafter-mainnet-workflow.md +++ b/spell/spell-crafter-mainnet-workflow.md @@ -217,7 +217,7 @@ Repo: https://github.com/makerdao/spells-mainnet * [ ] Commit & push changes for review * [ ] Wait for CI to PASS * [ ] Post a comment inside the PR containing: - * Foundry installation logs (from above) + * Relevant Foundry installation logs (from above or via `foundryup --version`) * A link to the deployed spell * A link to the created Tenderly Testnet * [ ] Notify the reviewers (e.g. "the spell was deployed") From acdeee31d92f84fbbcd309aaf58cf6775cff8530 Mon Sep 17 00:00:00 2001 From: SidestreamColdMelon Date: Thu, 21 Nov 2024 18:00:20 +0100 Subject: [PATCH 4/6] more specific requirement about logs --- spell/spell-crafter-mainnet-workflow.md | 4 ++-- spell/spell-reviewer-mainnet-checklist.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/spell/spell-crafter-mainnet-workflow.md b/spell/spell-crafter-mainnet-workflow.md index d17b2a9..a98b104 100644 --- a/spell/spell-crafter-mainnet-workflow.md +++ b/spell/spell-crafter-mainnet-workflow.md @@ -39,7 +39,7 @@ Repo: https://github.com/makerdao/spells-mainnet * [ ] Insert the release URL here: * [ ] Install the specified version via `foundryup --version git_tag_name` ``` - Document the relevant installation logs below + Document the installation logs containing installed versions below: ``` * Create new branch * [ ] Pull `master` branch of the `spells-mainnet` repo locally @@ -217,7 +217,7 @@ Repo: https://github.com/makerdao/spells-mainnet * [ ] Commit & push changes for review * [ ] Wait for CI to PASS * [ ] Post a comment inside the PR containing: - * Relevant Foundry installation logs (from above or via `foundryup --version`) + * Foundry installation logs containing installed versions (from above) * A link to the deployed spell * A link to the created Tenderly Testnet * [ ] Notify the reviewers (e.g. "the spell was deployed") diff --git a/spell/spell-reviewer-mainnet-checklist.md b/spell/spell-reviewer-mainnet-checklist.md index bc8aa82..2d539f5 100644 --- a/spell/spell-reviewer-mainnet-checklist.md +++ b/spell/spell-reviewer-mainnet-checklist.md @@ -7,7 +7,7 @@ * [ ] Insert the release URL here: * [ ] Install the specified version via `foundryup --version git_tag_name` ``` - Document the relevant installation logs below + Document the installation logs containing installed versions below: ``` * Preparation * [ ] Exec Sheet for the specified date is found in the ["Executive Vote Implementation Process" google sheet](https://docs.google.com/spreadsheets/d/1w_z5WpqxzwreCcaveB2Ye1PP5B8QAHDglzyxKHG3CHw) From 02efa5c83e786ac80664acdae0a3827c6e6c8aa0 Mon Sep 17 00:00:00 2001 From: SidestreamColdMelon Date: Wed, 27 Nov 2024 11:04:53 +0100 Subject: [PATCH 5/6] specify who's comment it is --- spell/spell-reviewer-mainnet-checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spell/spell-reviewer-mainnet-checklist.md b/spell/spell-reviewer-mainnet-checklist.md index 2d539f5..a30a9c9 100644 --- a/spell/spell-reviewer-mainnet-checklist.md +++ b/spell/spell-reviewer-mainnet-checklist.md @@ -370,7 +370,7 @@ _Insert your local test logs here_ ## Deployed Stage -* Comment in the PR: +* Crafter's comment in the PR * [ ] Contains relevant Foundry installation logs * [ ] Contains a URL to the deployed spell * [ ] URL matches the spell address declared in `config.sol` From 4bb82a0de58528e82cc0dff91b6456c02570df4f Mon Sep 17 00:00:00 2001 From: SidestreamColdMelon Date: Wed, 27 Nov 2024 11:15:11 +0100 Subject: [PATCH 6/6] fix CI --- .wordlist.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/.wordlist.txt b/.wordlist.txt index 40f45c3..c08e5b6 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -21,6 +21,7 @@ collaterals config configs Crafter +Crafter's cron CUs DAI