Skip to content

Commit

Permalink
Merge branch 'master' into update-spell-schedule
Browse files Browse the repository at this point in the history
  • Loading branch information
SidestreamColdMelon authored Feb 14, 2024
2 parents 9bef2e1 + 45b65c3 commit 6c0ea59
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 16 deletions.
1 change: 1 addition & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ Solmate
setIlkAutoLineDebtCeiling
ESM
testnet
testnets
authing
hardcoded
fileables
Expand Down
5 changes: 3 additions & 2 deletions spell/spell-crafter-goerli-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Repo: https://github.com/makerdao/spells-goerli
* [ ] Disable specific tests IF Not Used (e.g. `testCollateralIntegrations`, `testNewChainlogValues`, `testNewIlkRegistryValues`, ...)
* [ ] Remove spell-specific part
* [ ] Keep setup
* [ ] Disable by setting visibility to `private`
* [ ] Skip by adding the `skipped` modifier
* [ ] Add commented notes
* [ ] e.g. `// Insert new collateral integration tests here`
* [ ] Keep commented tests (e.g. `testOSMs`, `testMedianizers`)
Expand Down Expand Up @@ -107,7 +107,8 @@ Repo: https://github.com/makerdao/spells-goerli
* [ ] Add new ChainLog Address in `addresses_goerli.sol` (e.g. Collateral Onboarding)
* [ ] Run Tests `make test` or `make test match=<test_name>` to inspect debug traces
* [ ] Ensure Good Coverage
* [ ] Ensure every test function is declared as public if enabled or private if disabled
* [ ] Ensure every test function is declared as `public`
* [ ] IF the test needs to run, it MUST NOT have the `skipped` modifier; OTHERWISE, it MUST have the `skipped` modifier
* [ ] Tests PASS via `make test`
* [ ] Open PR & Add Reviewers
* [ ] Iterate until polls are ended and exec doc is confirmed
Expand Down
10 changes: 8 additions & 2 deletions spell/spell-crafter-mainnet-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Repo: https://github.com/makerdao/spells-mainnet
* [ ] Disable specific tests IF Not Used (e.g. `testCollateralIntegrations`, `testNewChainlogValues`, `testNewIlkRegistryValues`, ...)
* [ ] Remove spell-specific part
* [ ] Keep setup
* [ ] Disable by setting visibility to `private`
* [ ] Skip by adding the `skipped` modifier
* [ ] Add commented notes
* [ ] e.g. `// Insert new collateral integration tests here`
* [ ] Keep commented tests (e.g. `testOSMs`, `testMedianizers`)
Expand Down Expand Up @@ -141,7 +141,8 @@ Repo: https://github.com/makerdao/spells-mainnet
* [ ] Add new ChainLog Address in `addresses_mainnet.sol` (e.g. Collateral Onboarding)
* [ ] Run Tests `make test` or `make test match=<test_name>` to inspect debug traces
* [ ] Ensure Good Coverage
* [ ] Ensure every test function is declared as public if enabled or private if disabled
* [ ] Ensure every test function is declared as `public`
* [ ] IF the test needs to run, it MUST NOT have the `skipped` modifier; OTHERWISE, it MUST have the `skipped` modifier
* [ ] Tests PASS via `make test`
* [ ] Open PR & Add Reviewers
* [ ] Iterate until polls are ended and exec doc is confirmed
Expand Down Expand Up @@ -192,9 +193,14 @@ Repo: https://github.com/makerdao/spells-mainnet
* [ ] Ensure spell is verified on etherscan
* [ ] Ensure local tests PASS against deployed spell run via the deploy script
* [ ] Push auto-generated commit
* Cast spell on a newly created Tenderly Testnet
* [ ] Create testnet and cast deployed spell there using `make cast-on-tenderly spell=0x...` command (or a CI trigger)
* [ ] Check that returned `public explorer url` is publicly accessible (e.g. using incognito browser mode)
* [ ] If `cast-on-tenderly` command is executed several times for the same spell, delete all testnets of the same name except the last one
* [ ] Archive Spell via `make archive-spell` for current date or `date="YYYY-MM-DD" make archive-spell` (date as per target exec date)
* [ ] Commit & Push for Review
* [ ] Wait for CI to PASS
* [ ] Post a comment containing links to the deployed spell and Tenderly Testnet

## Handover and Merge Stage

Expand Down
16 changes: 9 additions & 7 deletions spell/spell-reviewer-goerli-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,15 +240,17 @@ Spell Actions (Per Exec Sheet):
* [ ] Ensure every spell variable is declared as `public`/`internal`
* [ ] Ensure every spell variable is used in the spell (no unused variables)
* [ ] Spell actions match the corresponding [Exec Sheet](https://docs.google.com/spreadsheets/d/1w_z5WpqxzwreCcaveB2Ye1PP5B8QAHDglzyxKHG3CHw)
* [ ] Tests
* [ ] Ensure each spell action has sufficient test coverage
_List actions for which coverage was checked here_
* [ ] Ensure every test function is declared as public if enabled or private if disabled
* Tests
* [ ] Ensure that the `DssExecLib.address` file is not being modified by the spell PR
* [ ] Check all CI tests are passing as at the latest commit
_Insert most recent commit hash where CI was passing_
* [ ] Ensure every test function is declared as `public`
* [ ] IF the test needs to run, it MUST NOT have the `skipped` modifier; OTHERWISE, it MUST have the `skipped` modifier
* [ ] Ensure each spell action has sufficient test coverage
_List actions for which coverage was checked here_
* [ ] Ensure that any other env variable does not affect execution of the tests (for example, by inspecting the output of `printenv | grep "FOUNDRY_\|DAPP_"`)
* [ ] Check all tests are passing locally using `make test`
* [ ] Ensure that only `ETH_RPC_URL` is being used from env (i.e. no `match`, `block` or similar are active in your env)
* [ ] Ensure every test listed in the _coverage_ item above is present in the logs with the `[PASS]` prefix.
```
_Insert your passing local tests here_
Expand Down Expand Up @@ -280,12 +282,12 @@ _Insert your passing local tests here_
* [ ] Archive matches `src`
* [ ] `make diff-archive-spell` for current date or or `date="YYYY-MM-DD" make diff-archive-spell` (date as per cast timestamp)
* [ ] Ensure date corresponds to target Exec Sheet date
* [ ] Tests
* Tests
* [ ] Ensure that the `DssExecLib.address` file is not being modified by the spell PR
* [ ] Check all CI tests are passing as at the latest commit
_Insert most recent commit hash where CI was passing_
* [ ] Ensure that only `ETH_RPC_URL` is being used from env (i.e. no `match`, `block` or similar are active in your env)
* [ ] Check all tests are passing locally using `make test`
* [ ] Ensure that only `ETH_RPC_URL` is being used from env (i.e. no `match`, `block` or similar are active in your env)
```
_Insert your passing local tests here_
Expand Down
19 changes: 14 additions & 5 deletions spell/spell-reviewer-mainnet-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -311,16 +311,18 @@
* [ ] Where addresses are fetched from the `ChainLog`, the variable name must match the value of the ChainLog key for that address (e.g. `MCD_VAT` rather than `vat`), except where the archive pattern differs from this pattern (e.g. MKR)
* [ ] Spell actions match the corresponding Exec Doc
* Tests
* [ ] Ensure each spell action has sufficient test coverage
_List actions for which coverage was checked here_
* [ ] Ensure every test function is declared as public if enabled or private if disabled
* [ ] Ensure that the `DssExecLib.address` file is not being modified by the spell PR
* [ ] Check all CI tests are passing as at the latest commit
_Insert most recent commit hash where CI was passing_
* [ ] Ensure every test function is declared as `public`
* [ ] IF the test needs to run, it MUST NOT have the `skipped` modifier; OTHERWISE, it MUST have the `skipped` modifier
* [ ] Ensure each spell action has sufficient test coverage
_List actions for which coverage was checked here_
* [ ] Ensure that any other env variable does not affect execution of the tests (for example, by inspecting the output of `printenv | grep "FOUNDRY_\|DAPP_"`)
* [ ] Check all tests are passing locally using `make test`
* [ ] Ensure every test listed in the _coverage_ item above is present in the logs and with the `[PASS]` prefix.
```bash
```
_Insert your local test logs here_
```
Expand Down Expand Up @@ -350,6 +352,13 @@ _Insert your local test logs here_
* [ ] Check again that the PR did not modify the `DssExecLib.address` file (e.g. look under the 'Files Changed' PR tab, etc.)
* [ ] Ensure Etherscan `Libraries Used` matches DssExecLib [Latest Release](https://github.com/makerdao/dss-exec-lib/releases/latest)
* [ ] (For your tests to be accurate) git submodule hash matches [dss-exec-lib](https://github.com/makerdao/dss-exec-lib/releases/latest) latest release's tag commit and inspect diffs if doesn't match to ensure expected behaviour (Currently Non-Critical pending the next DssExecLib release, double check that the ExecLib used by the contract matches the latest release)
* Tenderly Testnet checks
* [ ] A testnet with the name matching spell description is found at [maker dashboard](https://dashboard.tenderly.co/maker/virtual-networks)
* [ ] The testnet name is unique (previous testnets does not have the same name)
* [ ] Cast transaction is set to the correct "receiver" (matches deployed spell address)
* [ ] All actions are executed in the transaction trace
* [ ] No reverts are present that block execution
* [ ] No out-of-gas errors are present
* Archive checks
* [ ] `make diff-archive-spell` for current date or `make diff-archive-spell date="YYYY-MM-DD"`
* [ ] Ensure date corresponds to target Exec Doc date
Expand All @@ -360,7 +369,7 @@ _Insert your local test logs here_
* [ ] Ensure that any other env variable does not affect execution of the tests (for example, by inspecting the output of `printenv | grep "FOUNDRY_\|DAPP_"`)
* [ ] Check all tests are passing locally using `make test`
```bash
```
_Insert your local test logs here_
```
Expand Down

0 comments on commit 6c0ea59

Please sign in to comment.