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

Doc generation improvements with UniFFI library mode #6383

Closed
wants to merge 1 commit into from

Conversation

bendk
Copy link
Contributor

@bendk bendk commented Sep 19, 2024

Added a tool to run uniffi-bindgen in library mode. One nice thing about this is that it's much easier to figure out the library path in Rust than a shell script.

Use that script to simplify the generate docs scripts.

Pull Request checklist

  • Breaking changes: This PR follows our breaking change policy
    • This PR follows the breaking change policy:
      • This PR has no breaking API changes, or
      • There are corresponding PRs for our consumer applications that resolve the breaking changes and have been approved
  • Quality: This PR builds and tests run cleanly
    • Note:
      • For changes that need extra cross-platform testing, consider adding [ci full] to the PR title.
      • If this pull request includes a breaking change, consider cutting a new release after merging.
  • Tests: This PR includes thorough tests or an explanation of why it does not
  • Changelog: This PR includes a changelog entry in CHANGELOG.md or an explanation of why it does not need one
    • Any breaking changes to Swift or Kotlin binding APIs are noted explicitly
  • Dependencies: This PR follows our dependency management guidelines
    • Any new dependencies are accompanied by a summary of the due diligence applied in selecting them.

Branch builds: add [firefox-android: branch-name] to the PR title.

@bendk bendk requested a review from gruberb September 19, 2024 17:46
@codecov-commenter
Copy link

codecov-commenter commented Sep 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 22.00%. Comparing base (7625a2c) to head (e4bd0c4).

❗ There is a different number of reports uploaded between BASE (7625a2c) and HEAD (e4bd0c4). Click for more details.

HEAD has 1 upload less than BASE
Flag BASE (7625a2c) HEAD (e4bd0c4)
2 1
Additional details and impacted files
@@             Coverage Diff             @@
##             main    #6383       +/-   ##
===========================================
- Coverage   52.72%   22.00%   -30.73%     
===========================================
  Files         125      342      +217     
  Lines       12820    30721    +17901     
===========================================
  Hits         6759     6759               
- Misses       6061    23962    +17901     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bendk bendk force-pushed the push-vptlsxkuyxyu branch 2 times, most recently from beff544 to 5dbfe9b Compare September 19, 2024 18:23
Added a tool to run uniffi-bindgen in library mode.  One nice thing
about this is that it's much easier to figure out the library path in
Rust than a shell script.

Use that script to simplify the generate docs scripts.
@bendk
Copy link
Contributor Author

bendk commented Sep 19, 2024

Closing this so that I can rebase it on top of Bastian's PR and also because it's going to need mozilla/uniffi-rs#2240 since we're upgrading to UniFFI 0.28.1.

@bendk bendk closed this Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants