aptos-labs / aptos-core

Aptos is a layer 1 blockchain built to support the widespread use of blockchain through better technology and user experience.
https://aptosfoundation.org
Other
6.18k stars 3.66k forks source link

[SEV] Add a test to detect that CLI has become incompatible with framework (e.g. compilation errors) from the supported (see first point) branches. #9268

Open lbmeiyi opened 1 year ago

lbmeiyi commented 1 year ago

before it is implemented, we need to test them manually and better communication

Action item from https://aptoslabs.pagerduty.com/incidents/Q09ZMX1SM4MJWT CLI 1.0.14 compilation was broken

banool commented 1 year ago

Asking here: https://aptos-org.slack.com/archives/C036X27DZNG/p1694010072277529.

banool commented 1 year ago

Alright so we want to uphold the following invariant:

Compiling and publishing with the latest Aptos CLI should work when you are using the framework from the following branches with their corresponding networks:

As in, publishing to devnet with a Move.toml where rev = "devnet" should work:

[dependencies]
AptosFramework = { git = "https://github.com/aptos-labs/aptos-core.git", subdir = "aptos-move/framework/aptos-framework/", rev = devnet }

It so happens we already test for that:

So all we need to do is:

0xmigo commented 1 year ago

Add something to the docs site.

@banool Wanted to make sure. Which doc site are we referring to here?

banool commented 1 year ago

Whichever part of the docs talks about setting dependencies in Move packages (assuming we have such a section in the first place hahah).