Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from
Apr 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
11 changes: 6 additions & 5 deletions .github/workflows/build_test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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
7 changes: 3 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
264 changes: 264 additions & 0 deletions build/StarcoinFramework/BuildInfo.yaml
Original file line number Diff line number Diff line change
@@ -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: []
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/abis/DummyToken/mint.abi
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/abis/Genesis/initialize.abi
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/abis/GenesisNFT/mint.abi
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/abis/NFT/accept.abi
Binary file not shown.
Binary file added build/StarcoinFramework/abis/NFT/destroy_empty.abi
Binary file not shown.
Binary file added build/StarcoinFramework/abis/NFT/transfer.abi
Binary file not shown.
Binary file added build/StarcoinFramework/abis/Offer/take_offer.abi
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/abis/Oracle/update.abi
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/bytecode_modules/Arith.mv
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/bytecode_modules/BCS.mv
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/bytecode_modules/Block.mv
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/bytecode_modules/ChainId.mv
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/bytecode_modules/Compare.mv
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/bytecode_modules/Dao.mv
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/bytecode_modules/Debug.mv
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/bytecode_modules/Epoch.mv
Binary file not shown.
Binary file added build/StarcoinFramework/bytecode_modules/Errors.mv
Binary file not shown.
Binary file added build/StarcoinFramework/bytecode_modules/Event.mv
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/bytecode_modules/Hash.mv
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/bytecode_modules/Math.mv
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/bytecode_modules/NFT.mv
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/bytecode_modules/Offer.mv
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/bytecode_modules/SIP_2.mv
Binary file not shown.
Binary file added build/StarcoinFramework/bytecode_modules/SIP_3.mv
Binary file not shown.
Binary file added build/StarcoinFramework/bytecode_modules/STC.mv
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/bytecode_modules/Signer.mv
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/bytecode_modules/Token.mv
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/bytecode_modules/U256.mv
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added build/StarcoinFramework/bytecode_modules/Version.mv
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading