From 52d10b4cf9584854e3565c1e02ff21f75dcebd82 Mon Sep 17 00:00:00 2001 From: Ian Pun Date: Tue, 5 Mar 2024 09:30:01 -0800 Subject: [PATCH 1/8] initial files for migrate --- docs/tools/flow-cli/migrate/_category_.json | 4 ++++ docs/tools/flow-cli/migrate/migrate-get-staged-code.md | 0 docs/tools/flow-cli/migrate/migrate-is-staged.md | 0 docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md | 0 docs/tools/flow-cli/migrate/migrate-stage-contract.md | 0 docs/tools/flow-cli/migrate/migrate-unstage-contract.md | 0 6 files changed, 4 insertions(+) create mode 100644 docs/tools/flow-cli/migrate/_category_.json create mode 100644 docs/tools/flow-cli/migrate/migrate-get-staged-code.md create mode 100644 docs/tools/flow-cli/migrate/migrate-is-staged.md create mode 100644 docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md create mode 100644 docs/tools/flow-cli/migrate/migrate-stage-contract.md create mode 100644 docs/tools/flow-cli/migrate/migrate-unstage-contract.md diff --git a/docs/tools/flow-cli/migrate/_category_.json b/docs/tools/flow-cli/migrate/_category_.json new file mode 100644 index 0000000000..2c294afb9c --- /dev/null +++ b/docs/tools/flow-cli/migrate/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Migrate Projects to 1.0", + "position": 11 +} diff --git a/docs/tools/flow-cli/migrate/migrate-get-staged-code.md b/docs/tools/flow-cli/migrate/migrate-get-staged-code.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/tools/flow-cli/migrate/migrate-is-staged.md b/docs/tools/flow-cli/migrate/migrate-is-staged.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md b/docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/tools/flow-cli/migrate/migrate-stage-contract.md b/docs/tools/flow-cli/migrate/migrate-stage-contract.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/tools/flow-cli/migrate/migrate-unstage-contract.md b/docs/tools/flow-cli/migrate/migrate-unstage-contract.md new file mode 100644 index 0000000000..e69de29bb2 From b48ab47d8735503d07f4e43e3828089f44bdbb36 Mon Sep 17 00:00:00 2001 From: Ian Pun Date: Wed, 6 Mar 2024 13:45:32 -0800 Subject: [PATCH 2/8] add information about migration to docs --- .../migrate/migrate-get-staged-code.md | 28 +++++++++++++++++++ .../flow-cli/migrate/migrate-is-staged.md | 28 +++++++++++++++++++ .../migrate/migrate-list-staged-contracts.md | 21 ++++++++++++++ .../migrate/migrate-stage-contract.md | 28 +++++++++++++++++++ .../migrate/migrate-unstage-contract.md | 28 +++++++++++++++++++ 5 files changed, 133 insertions(+) diff --git a/docs/tools/flow-cli/migrate/migrate-get-staged-code.md b/docs/tools/flow-cli/migrate/migrate-get-staged-code.md index e69de29bb2..6cf6b104b0 100644 --- a/docs/tools/flow-cli/migrate/migrate-get-staged-code.md +++ b/docs/tools/flow-cli/migrate/migrate-get-staged-code.md @@ -0,0 +1,28 @@ +--- +title: Get staged Cadence 1.0 Contract Code +description: How to get staged Cadence 1.0 contract code from the command line +sidebar_position: 5 +--- + +Get the staged contract code from a contract thats been correctly staged. + +```shell +flow migrate staged_code +``` + +## Example Usage + +``` +> +flow migrate staged_code HelloWorld --network=previewnet + +Attempts to return the contract code of HelloWorld on the Previewnet network. + +``` + +## Arguments + +### Contract Name + +- Name: `contract_name` +- Valid Input: Existing contract name in `flow.json`. diff --git a/docs/tools/flow-cli/migrate/migrate-is-staged.md b/docs/tools/flow-cli/migrate/migrate-is-staged.md index e69de29bb2..eb74786038 100644 --- a/docs/tools/flow-cli/migrate/migrate-is-staged.md +++ b/docs/tools/flow-cli/migrate/migrate-is-staged.md @@ -0,0 +1,28 @@ +--- +title: Check if a contract is staged +description: How to check if a contract has been properly staged from the command line +sidebar_position: 4 +--- + +Check to see if a contract has been staged from the Flow CLI + +```shell +flow migrate is_staged +``` + +## Example Usage + +``` +> +flow migrate is_staged HelloWorld --network=previewnet + +Attempts to confirm if the contract has been staged on the Previewnet network. + +``` + +## Arguments + +### Contract Name + +- Name: `contract_name` +- Valid Input: Existing contract name in `flow.json`. diff --git a/docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md b/docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md index e69de29bb2..7b0081db40 100644 --- a/docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md +++ b/docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md @@ -0,0 +1,21 @@ +--- +title: List staged Cadence 1.0 Contracts +description: How to list staged Cadence 1.0 Contracts from the command line +sidebar_position: 3 +--- + +Lists all Cadence 1.0 supported contracts that are staged from the Flow CLI. + +```shell +flow migrate list-staged +``` + +## Example Usage + +``` +> +flow migrate list-staged --network=previewnet + +Lists all staged contracts from the Previewnet network. + +``` diff --git a/docs/tools/flow-cli/migrate/migrate-stage-contract.md b/docs/tools/flow-cli/migrate/migrate-stage-contract.md index e69de29bb2..7ca64bb65e 100644 --- a/docs/tools/flow-cli/migrate/migrate-stage-contract.md +++ b/docs/tools/flow-cli/migrate/migrate-stage-contract.md @@ -0,0 +1,28 @@ +--- +title: Staging a 1.0 Contract +description: How to stage a Cadence 1.0 supported Contract from the command line +sidebar_position: 1 +--- + +Stage a Cadence 1.0 supported contract project using the Flow CLI. + +```shell +flow migrate stage-contract +``` + +## Example Usage + +``` +> +flow migrate stage-contract HelloWorld --network=previewnet + +Attempts to the stage the contract `HelloWorld` onto the Previewnet network. + +``` + +## Arguments + +### Contract Name + +- Name: `contract_name` +- Valid Input: Existing contract name in `flow.json`. diff --git a/docs/tools/flow-cli/migrate/migrate-unstage-contract.md b/docs/tools/flow-cli/migrate/migrate-unstage-contract.md index e69de29bb2..fc2fa6d498 100644 --- a/docs/tools/flow-cli/migrate/migrate-unstage-contract.md +++ b/docs/tools/flow-cli/migrate/migrate-unstage-contract.md @@ -0,0 +1,28 @@ +--- +title: Unstaging a 1.0 Contract +description: How to unstage a Cadence 1.0 supported Contract from the command line +sidebar_position: 2 +--- + +Unstage a Cadence 1.0 supported contract project using the Flow CLI. + +```shell +flow migrate unstage-contract +``` + +## Example Usage + +``` +> +flow migrate unstage-contract HelloWorld --network=previewnet + +Attempts to the unstage the contract `HelloWorld` from the Previewnet network. + +``` + +## Arguments + +### Contract Name + +- Name: `contract_name` +- Valid Input: Existing contract name in `flow.json`. From a8967b81268317d6c9ac3a93f9113e9adbcdf94c Mon Sep 17 00:00:00 2001 From: Ian Pun Date: Wed, 6 Mar 2024 15:06:14 -0800 Subject: [PATCH 3/8] use testnet --- docs/tools/flow-cli/migrate/migrate-get-staged-code.md | 4 ++-- docs/tools/flow-cli/migrate/migrate-is-staged.md | 4 ++-- docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md | 4 ++-- docs/tools/flow-cli/migrate/migrate-stage-contract.md | 4 ++-- docs/tools/flow-cli/migrate/migrate-unstage-contract.md | 4 ++-- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/tools/flow-cli/migrate/migrate-get-staged-code.md b/docs/tools/flow-cli/migrate/migrate-get-staged-code.md index 6cf6b104b0..eeca5a22e6 100644 --- a/docs/tools/flow-cli/migrate/migrate-get-staged-code.md +++ b/docs/tools/flow-cli/migrate/migrate-get-staged-code.md @@ -14,9 +14,9 @@ flow migrate staged_code ``` > -flow migrate staged_code HelloWorld --network=previewnet +flow migrate staged_code HelloWorld --network=testnet -Attempts to return the contract code of HelloWorld on the Previewnet network. +Attempts to return the contract code of HelloWorld on the Testnet network. ``` diff --git a/docs/tools/flow-cli/migrate/migrate-is-staged.md b/docs/tools/flow-cli/migrate/migrate-is-staged.md index eb74786038..de4755aa98 100644 --- a/docs/tools/flow-cli/migrate/migrate-is-staged.md +++ b/docs/tools/flow-cli/migrate/migrate-is-staged.md @@ -14,9 +14,9 @@ flow migrate is_staged ``` > -flow migrate is_staged HelloWorld --network=previewnet +flow migrate is_staged HelloWorld --network=testnet -Attempts to confirm if the contract has been staged on the Previewnet network. +Attempts to confirm if the contract has been staged on the Testnet network. ``` diff --git a/docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md b/docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md index 7b0081db40..33bae69a81 100644 --- a/docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md +++ b/docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md @@ -14,8 +14,8 @@ flow migrate list-staged ``` > -flow migrate list-staged --network=previewnet +flow migrate list-staged --network=testnet -Lists all staged contracts from the Previewnet network. +Lists all staged contracts from the Testnet network. ``` diff --git a/docs/tools/flow-cli/migrate/migrate-stage-contract.md b/docs/tools/flow-cli/migrate/migrate-stage-contract.md index 7ca64bb65e..dad792529d 100644 --- a/docs/tools/flow-cli/migrate/migrate-stage-contract.md +++ b/docs/tools/flow-cli/migrate/migrate-stage-contract.md @@ -14,9 +14,9 @@ flow migrate stage-contract ``` > -flow migrate stage-contract HelloWorld --network=previewnet +flow migrate stage-contract HelloWorld --network=testnet -Attempts to the stage the contract `HelloWorld` onto the Previewnet network. +Attempts to the stage the contract `HelloWorld` onto the Testnet network. ``` diff --git a/docs/tools/flow-cli/migrate/migrate-unstage-contract.md b/docs/tools/flow-cli/migrate/migrate-unstage-contract.md index fc2fa6d498..89f83c3b23 100644 --- a/docs/tools/flow-cli/migrate/migrate-unstage-contract.md +++ b/docs/tools/flow-cli/migrate/migrate-unstage-contract.md @@ -14,9 +14,9 @@ flow migrate unstage-contract ``` > -flow migrate unstage-contract HelloWorld --network=previewnet +flow migrate unstage-contract HelloWorld --network=testnet -Attempts to the unstage the contract `HelloWorld` from the Previewnet network. +Attempts to the unstage the contract `HelloWorld` from the Testnet network. ``` From cc78abbb710a517871759d38c61f4f8a559c010b Mon Sep 17 00:00:00 2001 From: Tom Haile Date: Thu, 7 Mar 2024 15:51:59 -0600 Subject: [PATCH 4/8] Update migrate-get-staged-code.md remove extra /n --- docs/tools/flow-cli/migrate/migrate-get-staged-code.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/tools/flow-cli/migrate/migrate-get-staged-code.md b/docs/tools/flow-cli/migrate/migrate-get-staged-code.md index eeca5a22e6..043c085f6c 100644 --- a/docs/tools/flow-cli/migrate/migrate-get-staged-code.md +++ b/docs/tools/flow-cli/migrate/migrate-get-staged-code.md @@ -13,8 +13,7 @@ flow migrate staged_code ## Example Usage ``` -> -flow migrate staged_code HelloWorld --network=testnet +> flow migrate staged_code HelloWorld --network=testnet Attempts to return the contract code of HelloWorld on the Testnet network. From 4e85427bb99f6820862ae9181759d081145c731d Mon Sep 17 00:00:00 2001 From: Tom Haile Date: Thu, 7 Mar 2024 15:52:23 -0600 Subject: [PATCH 5/8] Update migrate-is-staged.md remove extra /n --- docs/tools/flow-cli/migrate/migrate-is-staged.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/tools/flow-cli/migrate/migrate-is-staged.md b/docs/tools/flow-cli/migrate/migrate-is-staged.md index de4755aa98..679d689445 100644 --- a/docs/tools/flow-cli/migrate/migrate-is-staged.md +++ b/docs/tools/flow-cli/migrate/migrate-is-staged.md @@ -13,8 +13,7 @@ flow migrate is_staged ## Example Usage ``` -> -flow migrate is_staged HelloWorld --network=testnet +> flow migrate is_staged HelloWorld --network=testnet Attempts to confirm if the contract has been staged on the Testnet network. From 58093c014d531f965136f2eb5ec24558854bbe9d Mon Sep 17 00:00:00 2001 From: Tom Haile Date: Thu, 7 Mar 2024 15:52:39 -0600 Subject: [PATCH 6/8] Update migrate-list-staged-contracts.md remove extra /n --- docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md b/docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md index 33bae69a81..a314398e12 100644 --- a/docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md +++ b/docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md @@ -13,8 +13,7 @@ flow migrate list-staged ## Example Usage ``` -> -flow migrate list-staged --network=testnet +> flow migrate list-staged --network=testnet Lists all staged contracts from the Testnet network. From ede7cf90d63e359ce7bc7f49c3fe4ee2dc085371 Mon Sep 17 00:00:00 2001 From: Tom Haile Date: Thu, 7 Mar 2024 15:52:57 -0600 Subject: [PATCH 7/8] Update migrate-stage-contract.md remove extra /n --- docs/tools/flow-cli/migrate/migrate-stage-contract.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/tools/flow-cli/migrate/migrate-stage-contract.md b/docs/tools/flow-cli/migrate/migrate-stage-contract.md index dad792529d..3e6de92be6 100644 --- a/docs/tools/flow-cli/migrate/migrate-stage-contract.md +++ b/docs/tools/flow-cli/migrate/migrate-stage-contract.md @@ -13,8 +13,7 @@ flow migrate stage-contract ## Example Usage ``` -> -flow migrate stage-contract HelloWorld --network=testnet +> flow migrate stage-contract HelloWorld --network=testnet Attempts to the stage the contract `HelloWorld` onto the Testnet network. From 9c7df4d724ff6adcbc2b15644d7bd3ce1f39d9b1 Mon Sep 17 00:00:00 2001 From: Tom Haile Date: Thu, 7 Mar 2024 15:53:12 -0600 Subject: [PATCH 8/8] Update migrate-unstage-contract.md remove extra /n --- docs/tools/flow-cli/migrate/migrate-unstage-contract.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/tools/flow-cli/migrate/migrate-unstage-contract.md b/docs/tools/flow-cli/migrate/migrate-unstage-contract.md index 89f83c3b23..05a605ac7f 100644 --- a/docs/tools/flow-cli/migrate/migrate-unstage-contract.md +++ b/docs/tools/flow-cli/migrate/migrate-unstage-contract.md @@ -13,8 +13,7 @@ flow migrate unstage-contract ## Example Usage ``` -> -flow migrate unstage-contract HelloWorld --network=testnet +> flow migrate unstage-contract HelloWorld --network=testnet Attempts to the unstage the contract `HelloWorld` from the Testnet network.