Skip to content

Commit

Permalink
docs: update commands to reference bazelisk (#1247)
Browse files Browse the repository at this point in the history
Description: bazelisk is the default and preferred way to build to ensure consistency as much as possible. This change updates the project's docs to refer to bazelisk when providing example build commands.

Signed-off-by: Mike Schore <mike.schore@gmail.com>
Signed-off-by: JP Simard <jp@jpsim.com>
  • Loading branch information
goaway authored and jpsim committed Nov 29, 2022
1 parent 138446e commit 25403cd
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion mobile/docs/root/development/performance/binary_size.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ necessary tools::
The binary being compiled is ``//test/performance:test_binary_size``.
The binary is getting built with the following build command::

bazel build //test/performance:test_binary_size --config=sizeopt --copt=-ggdb3 --linkopt=-fuse-ld=lld
bazelisk build //test/performance:test_binary_size --config=sizeopt --copt=-ggdb3 --linkopt=-fuse-ld=lld

Thus the binary is compiled with the following flags pertinent to reducing
binary size:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Modified versions of the "hello world" example apps were used to run these exper

Getting the build:

1. Build the library using ``bazel build android_dist --config=android --fat_apk_cpu=armeabi-v7a``
1. Build the library using ``bazelisk build android_dist --config=android --fat_apk_cpu=armeabi-v7a``
2. Control: ``bazel mobile-install //examples/kotlin/control:hello_control_kt``
3. Envoy: ``bazel mobile-install //examples/kotlin/hello_world:hello_envoy_kt --fat_apk_cpu=armeabi-v7a``

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Android configuration

2. Build and run the example app:

``bazel mobile-install //examples/kotlin/hello_world:hello_envoy_kt --fat_apk_cpu=armeabi-v7a``
``bazelisk mobile-install //examples/kotlin/hello_world:hello_envoy_kt --fat_apk_cpu=armeabi-v7a``

~~~~~~~~~~~
Open issues
Expand Down
6 changes: 3 additions & 3 deletions mobile/docs/root/development/testing/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,20 @@ Java tests

To run the entire Java unit test suite locally, use the following Bazel command:

``bazel test --test_output=all --build_tests_only //library/java/test/...``
``bazelisk test --test_output=all --build_tests_only //library/java/test/...``

------------
Kotlin tests
------------

To run the entire Kotlin unit test suite locally, use the following Bazel command:

``bazel test --test_output=all --build_tests_only //library/kotlin/test/...``
``bazelisk test --test_output=all --build_tests_only //library/kotlin/test/...``

-----------
Swift tests
-----------

To run the entire Swift unit test suite locally, use the following Bazel command:

``bazel test --test_output=all --build_tests_only //library/swift/test/...``
``bazelisk test --test_output=all --build_tests_only //library/swift/test/...``
8 changes: 4 additions & 4 deletions mobile/docs/root/start/building/building.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,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 --fat_apk_cpu=<arch1,arch2>``
``bazelisk build android_dist --config=android --fat_apk_cpu=<arch1,arch2>``

Upon completion of the build, you'll see an ``envoy.aar`` file at :repo:`dist/envoy.aar <dist>`.

Expand All @@ -64,7 +64,7 @@ an example of how this artifact may be used.
**When building the artifact for release** (usage outside of development), be sure to include the
``--config=release-android`` option, along with the architectures for which the artifact is being built:

``bazel build android_dist --config=release-android --fat_apk_cpu=x86,armeabi-v7a,arm64-v8a``
``bazelisk build android_dist --config=release-android --fat_apk_cpu=x86,armeabi-v7a,arm64-v8a``

For a demo of a working app using this artifact, see the :ref:`hello_world` example.

Expand All @@ -77,7 +77,7 @@ iOS static framework
Envoy Mobile supports being compiled into a ``.framework`` 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``
``bazelisk build ios_dist --config=ios``

Upon completion of the build, you'll see a ``Envoy.framework`` directory at
:repo:`dist/Envoy.framework <dist>`.
Expand All @@ -91,7 +91,7 @@ example of how this artifact may be used.
**When building the artifact for release** (usage outside of development), be sure to include the
``--config=release-ios`` option, along with the architectures for which the artifact is being built:

``bazel build ios_dist --config=release-ios --ios_multi_cpus=i386,x86_64,armv7,arm64``
``bazelisk build ios_dist --config=release-ios --ios_multi_cpus=i386,x86_64,armv7,arm64``

For a demo of a working app using this artifact, see the :ref:`hello_world` example.

Expand Down
8 changes: 4 additions & 4 deletions mobile/docs/root/start/examples/hello_world.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Next, make sure you have an Android simulator running.

Run the :repo:`sample app <examples/java/hello_world>` using the following Bazel build rule:

``bazel mobile-install //examples/java/hello_world:hello_envoy --fat_apk_cpu=<arch1,arch2>``
``bazelisk mobile-install //examples/java/hello_world:hello_envoy --fat_apk_cpu=<arch1,arch2>``

You should see a new app installed on your simulator called ``Hello Envoy``.
Open it up, and requests will start flowing!
Expand All @@ -38,7 +38,7 @@ Next, make sure you have an Android simulator running.

Run the :repo:`sample app <examples/kotlin/hello_world>` using the following Bazel build rule:

``bazel mobile-install //examples/kotlin/hello_world:hello_envoy_kt --fat_apk_cpu=<arch1,arch2>``
``bazelisk mobile-install //examples/kotlin/hello_world:hello_envoy_kt --fat_apk_cpu=<arch1,arch2>``

You should see a new app installed on your simulator called ``Hello Envoy Kotlin``.
Open it up, and requests will start flowing!
Expand All @@ -51,7 +51,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``
``bazelisk 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 @@ -63,6 +63,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``
``bazelisk 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 25403cd

Please sign in to comment.