-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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
[Docs] Document and announce CLI features for generating testing coverage and passing bytecode as dependencies #7060
Comments
Hi @clay-aptos, this page is dedicated to introducing move unit testing. Maybe we should add coverage to this page too. |
Hi Teng, we can certainly do that. In fact, @wrwg is working on a tutorial that mentions test coverage too. Perhaps we can update both to point to the page we have in development. Thank you! |
Oh wow. Good find Teng! I wasn't aware that the Move book (just recently copied into our docset) uses the Move CLI to document unit testing. We should rewrite this to use the Aptos CLI. Also as we do we should definitely document the coverage. In general, I think we should document all |
PS. The test documentation is also outdated. I think there is a |
Related, I am announcing the ported Move tutorial (and renaming in links slightly per @davidiw ) and updating its links in the Move Book in: I will sift through the site for links into the old Move Book and replace next. Keeping this open to track that related work since the PR where this was reported has been merged: |
PR #7316 to fix some of the contents in Aptos Move Book. @clay-aptos @wrwg |
Let's track the site link fixes to the book and tutorial here: Closing this out. Please reopen if you see anything amiss here. Thank you, Teng, Wolfgang and team! |
Aptos Documentation Issue
Location
Where should this information land if new? (Start Aptos, Build Apps, Run Nodes, Reference, etc.)
What are the existing URLs containing the issue, if any?
https://aptos.dev/cli-tools/aptos-cli-tool/use-aptos-cli/#compiling-and-unit-testing-move
https://aptos.dev/guides/move-guides/aptos-move-guides/
Description
Teng and I met to document two new Move-related features landing in the Aptos CLI:
Generate testing coverage information for Move packages.
Support for using bytecode as dependencies for compilation and publishing of Move packages.
For #1, Teng notes this functionality existed in the Move compiler and has ported the functionality to Aptos in:
#6893
We will add that information to the Using the Aptos CLI doc, below the section highlighted above.
For #2, Teng has an excellent internal doc titled "Use bytecode as dependencies in compilation" we will edit, convert and place among the Move guides, linking from the same #compiling-and-unit-testing-move section of Using the Aptos CLI above.
We are also asking @thepomeranian to help us get these features in the Aptos CLI release notes. We can help summarize. Frances, let us know what you need from us.
Audience
Our audience is Move developers.
Additional context
We recorded the meeting, so I will pull details from that as well.
The text was updated successfully, but these errors were encountered: