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

[Docs] Document and announce CLI features for generating testing coverage and passing bytecode as dependencies #7060

Closed
clay-aptos opened this issue Mar 10, 2023 · 8 comments
Assignees
Labels
documentation Improvements or additions to documentation P1 Priority 1

Comments

@clay-aptos
Copy link
Contributor

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:

  1. Generate testing coverage information for Move packages.

  2. 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.

@clay-aptos clay-aptos added the documentation Improvements or additions to documentation label Mar 10, 2023
@clay-aptos clay-aptos moved this to 🏗 In progress in Aptos Docs Mar 10, 2023
@clay-aptos clay-aptos added the P1 Priority 1 label Mar 10, 2023
@rahxephon89
Copy link
Contributor

Hi @clay-aptos, this page is dedicated to introducing move unit testing. Maybe we should add coverage to this page too.

@clay-aptos
Copy link
Contributor Author

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!

@wrwg
Copy link
Contributor

wrwg commented Mar 15, 2023

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 aptos move * commands in our version of the Move book, as a kind of reference to the language platform. Do you want to take a try on updating the unit test page, @rahxephon89 ?

@wrwg
Copy link
Contributor

wrwg commented Mar 15, 2023

PS. The test documentation is also outdated. I think there is a location = Self field missing in the abort expectations.

@lbmeiyi lbmeiyi moved this from 🆕 New to 🏗 In progress in Move Language and Runtime Mar 15, 2023
@rahxephon89
Copy link
Contributor

@wrwg The PR to add documents for coverage and bytecode as dependencies have been merged. I will add the corresponding content to the test document when fixing the Aptos move book.

@clay-aptos
Copy link
Contributor Author

Related, I am announcing the ported Move tutorial (and renaming in links slightly per @davidiw ) and updating its links in the Move Book in:
#7308

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:
#7048 (comment)

@rahxephon89
Copy link
Contributor

PR #7316 to fix some of the contents in Aptos Move Book. @clay-aptos @wrwg

@clay-aptos
Copy link
Contributor Author

Let's track the site link fixes to the book and tutorial here:
#7364 (comment)

Closing this out. Please reopen if you see anything amiss here. Thank you, Teng, Wolfgang and team!

@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Aptos Docs Mar 27, 2023
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Move Language and Runtime Mar 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation P1 Priority 1
Projects
Archived in project
Archived in project
Development

No branches or pull requests

5 participants