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

Improves the documentation on how to configure build.rs #1743

Merged

Conversation

patmuk
Copy link
Contributor

@patmuk patmuk commented Feb 8, 2024

Changes

Fixes #1742

Checklist

  • An issue to be fixed by this PR is listed above.
  • New tests are added to ensure new features are working. Please refer to this page to see how to add a test.
  • ./frb_internal precommit --mode slow (or fast) is run (it internal runs code generator, does auto formatting, etc).
  • If this PR adds/changes features, documentations (in the ./website folder) are updated.
  • CI is passing. Please refer to this page to see how to solve a failed CI.

@fzyzcjy please not that I took the liberty to change the md-file to have one sentence per line. In this way, future changes are easier to see in the diff. The output should not be affected by this reformatting.

Probably my description is a bit to verbose - feel free to reformulate or ask me to do so!

Copy link

codecov bot commented Feb 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (f221ce8) 99.27% compared to head (26550cb) 99.25%.

❗ Current head 26550cb differs from pull request most recent head a56e856. Consider uploading reports for the commit a56e856 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1743      +/-   ##
==========================================
- Coverage   99.27%   99.25%   -0.02%     
==========================================
  Files         357      357              
  Lines       14813    14813              
==========================================
- Hits        14705    14703       -2     
- Misses        108      110       +2     

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

@patmuk
Copy link
Contributor Author

patmuk commented Feb 8, 2024

@fzyzcjy I guess all is fine (except for you to have an editorial look upon the proposed reformulation).
The CI fails two tasks:

  1. Code coverage shrank -> not sure why, as even the report states that no file changed. I accidentally used a wrong comment sign in the cargo.toml, and fixed that - so maybe it complains about introducing and then removing a line. Though the report compares master with the last commit in this branch.
  2. frb_example/flutter_via_create fails. I did not changed anything there, maybe a flaky run?

@fzyzcjy
Copy link
Owner

fzyzcjy commented Feb 8, 2024

Code coverage shrank, frb_example/flutter_via_create fails

Just flaky, no worries!

@fzyzcjy fzyzcjy changed the title improves the documentation on how to configure build.rs Improves the documentation on how to configure build.rs Feb 8, 2024
@fzyzcjy fzyzcjy merged commit f4131fc into fzyzcjy:master Feb 8, 2024
@patmuk
Copy link
Contributor Author

patmuk commented Feb 9, 2024

@fzyzcjy thanks for the corrections!

@fzyzcjy
Copy link
Owner

fzyzcjy commented Feb 9, 2024

You are welcome!

@patmuk patmuk deleted the fix-#1742-improve-build.rs-documentation branch September 15, 2024 04:36
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.

Improve build.rs configuration documentations
2 participants