e9184c793e
Summary: This change starts adding more coverage to GitHub Actions. Existing workflows are split up to be per-platform, and stale scripts, etc are removed. We are currently limited a bit by issues with the build itself, but this still adds a good bit of coverage that readily works, and adds places to inject more. Another option would have been to move these to CircleCI where we have more credits, or used docker images instead of manual setup steps. etc, The Yoga build and number of changes is very light though, so we don't really need the complexity yet. Some TODOs: 1. Fix the Apple Builds (pod lint and pod install return errors seen by the community) 2. Add working Android UTs 3. Add C++ UTs 4. Add Apple Publish 5. Add version stamping Changelog: [Internal][Added] - Start Adding Yoga GitHub Actions Pull Request resolved: https://github.com/facebook/yoga/pull/1165 Reviewed By: cortinico Differential Revision: D40386426 Pulled By: NickGerleman fbshipit-source-id: c540dd25bfec6ac8c05e461c1236ef7fe6cb8598
71 lines
4.3 KiB
Markdown
71 lines
4.3 KiB
Markdown
# Yoga [](https://opensource.fb.com/support-ukraine) [](http://cocoapods.org/pods/YogaKit) [](https://www.npmjs.com/package/yoga-layout) [](https://bintray.com/facebook/maven/com.facebook.yoga%3Ayoga/_latestVersion) [](https://www.nuget.org/packages/Facebook.Yoga)
|
|
|
|
## Building
|
|
Yoga builds with [buck](https://buckbuild.com). Make sure you install buck before contributing to Yoga. Yoga's main implementation is in C++, with bindings to supported languages and frameworks. When making changes to Yoga please ensure the changes are also propagated to these bindings when applicable.
|
|
|
|
Alternatively, you can build and install Yoga using [vcpkg](https://github.com/Microsoft/vcpkg/) dependency manager:
|
|
|
|
```sh
|
|
git clone https://github.com/Microsoft/vcpkg.git
|
|
cd vcpkg
|
|
./bootstrap-vcpkg.sh
|
|
./vcpkg integrate install
|
|
./vcpkg install yoga
|
|
```
|
|
|
|
The Yoga port in vcpkg is kept up to date by Microsoft team members and community contributors.
|
|
|
|
If the version is out of date, please [create an issue or pull request](https://github.com/Microsoft/vcpkg) on the vcpkg repository.
|
|
|
|
## Testing
|
|
For testing we rely on [gtest](https://github.com/google/googletest) as a submodule. After cloning Yoga run `git submodule init` followed by `git submodule update`.
|
|
|
|
For any changes you make you should ensure that all the tests are passing. In case you make any fixes or additions to the library please also add tests for that change to ensure we don't break anything in the future. Tests are located in the `tests` directory. Run the tests by executing `buck test //:yoga`.
|
|
|
|
Instead of manually writing a test which ensures parity with web implementations of Flexbox you can run `gentest/gentest.rb` to generate a test for you. You can write html which you want to verify in Yoga, in `gentest/fixtures` folder, such as the following.
|
|
|
|
```html
|
|
<div id="my_test" style="width: 100px; height: 100px; align-items: center;">
|
|
<div style="width: 50px; height: 50px;"></div>
|
|
</div>
|
|
```
|
|
|
|
Run `gentest/gentest.rb` to generate test code and re-run `buck test //:yoga` to validate the behavior. One test case will be generated for every root `div` in the input html.
|
|
|
|
You should run `bundle install` in the `gentest` directory to install dependencies for the `gentest/gentest.rb` Ruby script.
|
|
|
|
### .NET
|
|
.NET testing is not integrated in buck yet, you might need to set up .NET testing environment. We have a script which to launch C# test on macOS, `csharp/tests/Facebook.Yoga/test_macos.sh`.
|
|
|
|
## Benchmarks
|
|
Benchmarks are located in `benchmark/YGBenchmark.c` and can be run with `buck run //benchmark:benchmark`. If you think your change has affected performance please run this before and after your change to validate that nothing has regressed. Benchmarks are run on every commit in CI.
|
|
|
|
### JavaScript
|
|
Installing through NPM
|
|
```sh
|
|
npm install yoga-layout
|
|
```
|
|
By default this will install the library and try to build for all platforms (node, browser asm, and standalone webpack). You may receive errors if you do not have the required platform development tools already installed. To preset the platform you'd like to build for you can set a .npmrc property first.
|
|
```sh
|
|
npm config set yoga-layout:platform standalone
|
|
```
|
|
This will now only run the standalone webpack build upon install.
|
|
|
|
## Build Platforms
|
|
|
|
| name | description |
|
|
|----------------|-------------------------------------------------|
|
|
| all (default) | Builds all of these platforms. |
|
|
| browser | Builds asm js browser version. |
|
|
| node | Builds node js version. |
|
|
| standalone | Runs webpack. |
|
|
| none | Does nothing. You can use the prepackaged libs. |
|
|
|
|
## Maintainer Release Guide
|
|
|
|
Release artifacts are published automatically when a new GitHub release is
|
|
created. The publishing workflows may also be executed manually, given a Git
|
|
Tag, to re-attempt publish.
|
|
|
|
NPM and NuGet packages are not currently published.
|