Skip to content

Commit

Permalink
docs: update to mention bazelw wrapper (#259)
Browse files Browse the repository at this point in the history
Signed-off-by: Mike Schore <[email protected]>
  • Loading branch information
goaway authored Jul 15, 2019
1 parent 8898114 commit 75701c3
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
8 changes: 5 additions & 3 deletions docs/root/start/building/building.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <ci/mac_ci_setup.sh>` and :repo:`linux <ci/linux_ci_setup.sh>`,
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
--------------------
Expand All @@ -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 <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 <dist>`.

Expand All @@ -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 <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 <dist>`.
Expand Down
8 changes: 4 additions & 4 deletions docs/root/start/examples/hello_world.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ First, build the :ref:`android_aar` artifact.
Next, run the :repo:`sample app <examples/java/hello_world>` 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!
Expand All @@ -51,7 +51,7 @@ First, build the :ref:`android_aar` artifact.
Next, run the :repo:`sample app <examples/kotlin/hello_world>` 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!
Expand All @@ -70,7 +70,7 @@ First, build the :ref:`ios_framework` artifact.
Next, run the :repo:`sample app <examples/objective-c/hello_world>` 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!

Expand All @@ -82,6 +82,6 @@ First, build the :ref:`ios_framework` artifact.

Next, run the :repo:`sample app <examples/swift/hello_world>` 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!

0 comments on commit 75701c3

Please sign in to comment.