diff --git a/docs/root/start/building/building.rst b/docs/root/start/building/building.rst index 0408290b78..865e5c56ad 100644 --- a/docs/root/start/building/building.rst +++ b/docs/root/start/building/building.rst @@ -21,10 +21,12 @@ submodule with ``git submodule update --init``. Bazel requirements ------------------ -Envoy-Mobile is compiled using Bazel 0.26.1. +Envoy-Mobile is compiled using Bazel 0.28.0. Take a look at our CI set up for :repo:`mac ` and :repo:`linux `, in order to see how to install a specific Bazel version in your environment. +To assist with build consistency across environments, a `bazelw` script is included in project root, along with several common build configurations included in the project's `.bazelrc`. + -------------------- Android requirements -------------------- @@ -49,7 +51,7 @@ Android AAR Envoy Mobile can be compiled into an ``.aar`` file for use with Android apps. This command is defined in the main :repo:`BUILD ` file of the repo, and may be run locally: -``bazel build android_dist --config=android`` +``./bazelw build android_dist --config=android`` Upon completion of the build, you'll see an ``envoy.aar`` file at :repo:`dist/envoy.aar `. @@ -71,7 +73,7 @@ iOS static framework Envoy Mobile supports being compiled into a ``.framework`` directory for consumption by iOS apps. This command is defined in the main :repo:`BUILD ` file of the repo, and may be run locally: -``bazel build ios_dist --config=ios`` +``./bazelw build ios_dist --config=ios`` Upon completion of the build, you'll see a ``Envoy.framework`` directory at :repo:`dist/Envoy.framework `. diff --git a/docs/root/start/examples/hello_world.rst b/docs/root/start/examples/hello_world.rst index 530d92e9f1..9833b54fc6 100644 --- a/docs/root/start/examples/hello_world.rst +++ b/docs/root/start/examples/hello_world.rst @@ -37,7 +37,7 @@ First, build the :ref:`android_aar` artifact. Next, run the :repo:`sample app ` using the following Bazel build rule. Make sure you have an Android simulator running already: -``bazel mobile-install //examples/java/hello_world:hello_envoy --fat_apk_cpu=x86`` +``./bazelw mobile-install //examples/java/hello_world:hello_envoy --fat_apk_cpu=x86`` You should see a new app installed on your simulator called ``Hello Envoy``. Open it up, and requests will start flowing! @@ -51,7 +51,7 @@ First, build the :ref:`android_aar` artifact. Next, run the :repo:`sample app ` using the following Bazel build rule. Make sure you have an Android simulator running already: -``bazel mobile-install //examples/kotlin/hello_world:hello_envoy_kt --fat_apk_cpu=x86`` +``./bazelw mobile-install //examples/kotlin/hello_world:hello_envoy_kt --fat_apk_cpu=x86`` You should see a new app installed on your simulator called ``Hello Envoy Kotlin``. Open it up, and requests will start flowing! @@ -70,7 +70,7 @@ First, build the :ref:`ios_framework` artifact. Next, run the :repo:`sample app ` using the following Bazel build rule. -``bazel run //examples/objective-c/hello_world:app --config=ios`` +``./bazelw run //examples/objective-c/hello_world:app --config=ios`` This will start a simulator and open a new app. You should see requests start flowing! @@ -82,6 +82,6 @@ First, build the :ref:`ios_framework` artifact. Next, run the :repo:`sample app ` using the following Bazel build rule. -``bazel run //examples/swift/hello_world:app --config=ios`` +``./bazelw run //examples/swift/hello_world:app --config=ios`` This will start a simulator and open a new app. You should see requests start flowing!