Skip to content
This repository has been archived by the owner on Feb 20, 2023. It is now read-only.

For #5200: Update build docs to reflect new variants #5220

Merged
merged 3 commits into from
Sep 11, 2019
Merged

For #5200: Update build docs to reflect new variants #5220

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8a26834
For #5200: Update build docs to reflect new variants
colintheshots Sep 11, 2019
2233513
Added a description of the build variants
colintheshots Sep 11, 2019
9cb5e06
Added data loss warning
colintheshots Sep 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 21 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,22 +48,38 @@ Before you attempt to make a contribution please read the [Community Participati

## Build Instructions

Note: Both Android SDK and NDK are required.

1. Clone or Download the repository:

```shell
git clone https://github.com/mozilla-mobile/fenix
```

2. Import the project into Android Studio **or** build on the command line:
2. **Import** the project into Android Studio **or** build on the command line:

```shell
./gradlew clean app:assembleArmDebug
./gradlew clean app:assembleGeckoBetaDebug
```

Use app:assembleGeckoNightlyDebug to build with the Gecko Nightly version instead.

3. Make sure to select the correct build variant in Android Studio:
**armDebug** for ARM
**x86Debug** for X86
3. Make sure to select the correct build variant in Android Studio. See the next section.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might also suggest adding the recommended flavor in this line too (if people don't want to read the next section).
build variant in Android Studio (recommended: geckoBetaDebug).


### Guide to Build Variants
We have a lot of build variants. Each variant is composed of two flavors. One flavor is the version of Gecko to use and the other describes
which app id and settings to use. Here is a description of what each means:

**geckoBeta** (recommended) uses the Beta variant of the Gecko rendering engine, which corresponds to the next version of Gecko which will go to production
**geckoNightly** uses the Nightly variant of the Gecko rendering engine, which is the version which will arrive after beta and is less stable

**debug** uses debug symbols and debug signing, adds tools like LeakCanary for troubleshooting, and does not strip unused or wasteful code
**fenixNightly** is a release build with nightly signing which uses the org.mozilla.fenix.nightly app id for nightly releases to Google Play
**fenixNightlyLegacy** is a release build with release signing which uses the org.mozilla.fenix production app id along with nightly logos, which we're trying to phase out
**fenixBeta** is a release build with beta signing which uses the org.mozilla.fenix.beta app id for beta releases to Google Play
**fenixProduction** is a release build with release signing which uses the org.mozilla.fenix app id for production releases to Google Play
**fennecProduction** is an experimental build with release signing which uses the org.mozilla.firefox app id and supports upgrading the older Firefox. **WARNING** Pre-production versions of this may result in data loss.
**forPerformanceTest** is a release build with the debuggable flag set and test activities enabled for running Raptor performance tests

## Pre-push hooks
To reduce review turn-around time, we'd like all pushes to run tests locally. We'd
Expand Down