Add a script to generate docs and commit docs to git (#21)

* Add a script to build and keep the build result to git

* mv the v11 to release

.github/workflows/build_test.yml

@@ -20,11 +20,7 @@ jobs:
           profile: minimal
       - name: setup environment
         run: |
-          bash scripts/dev_setup.sh -b -t -y -p
-      - name: build
-        run: |
-          source "$HOME/.profile"
-          mpm package build
+          bash scripts/dev_setup.sh -b -t -y -p 
       - name: test
         run: |
           source "$HOME/.profile"
@@ -37,5 +33,10 @@ jobs:
         run: |
           source "$HOME/.profile"
           mpm package prove
+      # last run build for generate all abi and docs
+      - name: build
+        run: |
+          source "$HOME/.profile"
+          bash ./scripts/build.sh
       - name: check changed files
         run: bash ./scripts/changed-files.sh

.gitignore

@@ -36,14 +36,13 @@ Temporary Items
 # Github action's files
 packages-microsoft-prod.deb
 
-examples/*.mv
 
 # Move trace file.
 *.mvcov
 
-# Move Build Output
-build/
-*.bak
+# Move Build Output sources
+build/StarcoinFramework/sources/*.move
+build/UnitTest
 
 # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
 # More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html

README.md

@@ -48,7 +48,9 @@ Contributions in the following are welcome:
 1. Add New Move module to `sources` dir, such as `MyModule.move`.
 2. Write Move code and add unit test in the module file.
 3. Add a spec test [spectests](../spectests), such as: `test_my_module.move`.
-4. Run the spec test `mpm spectest test_my_module.move `
+4. Run the spec test `mpm spectest test_my_module.move `.
+5. Run script `./script/build.sh` for build and generate documents.
+6. Commit the changes and create a pull request.
 
 If you are not sure that the module belongs to starcoin-framework, please submit it to [starcoin-framework-commons](https://github.com/starcoinorg/starcoin-framework-commons) first.
 

build/StarcoinFramework/BuildInfo.yaml

@@ -0,0 +1,264 @@
+---
+compiled_package_info:
+  package_name: StarcoinFramework
+  address_alias_instantiation:
+    StarcoinAssociation: "0x0000000000000000000000000a550c18"
+    StarcoinFramework: "0x00000000000000000000000000000001"
+    VMReserved: "0x00000000000000000000000000000000"
+  module_resolution_metadata:
+    ? address: "0x00000000000000000000000000000001"
+      name: Account
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: AccountScripts
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Arith
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Authenticator
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: BCS
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: BitOperators
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Block
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: BlockReward
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: ChainId
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Collection
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Collection2
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Compare
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Config
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: ConsensusConfig
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: ConsensusStrategy
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: CoreAddresses
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Dao
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: DaoVoteScripts
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Debug
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: DummyToken
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: DummyTokenScripts
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: EVMAddress
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: EmptyScripts
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Epoch
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Errors
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Event
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: FixedPoint32
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Genesis
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: GenesisNFT
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: GenesisNFTScripts
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: GenesisSignerCapability
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Hash
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: IdentifierNFT
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: IdentifierNFTScripts
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: LanguageVersion
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Math
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: MerkleNFTDistributor
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: MerkleProof
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: MintDaoProposal
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: MintScripts
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: ModifyDaoConfigProposal
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: ModuleUpgradeScripts
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: NFT
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: NFTGallery
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: NFTGalleryScripts
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Offer
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: OnChainConfigDao
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: OnChainConfigScripts
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Option
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Oracle
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: PackageTxnManager
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: PriceOracle
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: PriceOracleAggregator
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: PriceOracleScripts
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: RewardConfig
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: SIP_2
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: SIP_3
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: STC
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: STCUSDOracle
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: SharedEd25519PublicKey
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Signature
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: SignedInteger64
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Signer
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: StdlibUpgradeScripts
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Timestamp
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Token
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: TransactionFee
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: TransactionManager
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: TransactionPublishOption
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: TransactionTimeout
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: TransactionTimeoutConfig
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: TransferScripts
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Treasury
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: TreasuryScripts
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: TreasuryWithdrawDaoProposal
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: U256
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: UpgradeModuleDaoProposal
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: VMConfig
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Vector
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: Version
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: YieldFarming
+    : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: YieldFarmingV2
+    : StarcoinFramework
+  source_digest: 346F92F1B97DB6DD3C1A2ADB8B9FFAB54B79C2A525A7813EEC9DF8E9ADF3D1EB
+  build_flags:
+    dev_mode: false
+    test_mode: false
+    generate_docs: true
+    generate_abis: true
+    install_dir: ~
+    force_recompilation: true
+    additional_named_addresses: {}
+dependencies: []