For #5200: Update build docs to reflect new variants #5220
Conversation
Codecov Report
@@ Coverage Diff @@
## master #5220 +/- ##
=========================================
Coverage 11.55% 11.55%
Complexity 239 239
=========================================
Files 244 244
Lines 9954 9954
Branches 1447 1447
=========================================
Hits 1150 1150
Misses 8733 8733
Partials 71 71Continue to review full report at Codecov.
|
README.md
Outdated
| **armDebug** for ARM | ||
| **x86Debug** for X86 | ||
| **geckoBetaDebug** for the beta version of the Gecko engine | ||
| **geckoNightlyDebug** for the nightly version of the Gecko engine |
There was a problem hiding this comment.
I'd also add "recommended" on the geckoBetaDebug line.
Optional: could we also add a small section explaining what the other variants are? Or describe how this naming is made (e.g. geckoVersionFenixVersion).
README.md
Outdated
| @@ -58,12 +59,14 @@ Before you attempt to make a contribution please read the [Community Participati | |||
| 2. Import the project into Android Studio **or** build on the command line: | |||
There was a problem hiding this comment.
Unrelated: Bold the word "import"
colintheshots
force-pushed
the
updateDocs
branch
4 times, most recently
from
fa4a39a
to
b49e09d
Compare
There was a problem hiding this comment.
thanks @colintheshots ! these explanations are great.
Also, in the future when people change/add build variants, we should remember ask them to update the README too.
README.md
Outdated
| **fenixNightlyLegacy** is a release build with release signing which uses the org.mozilla.fenix production app id, 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 relases 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 |
There was a problem hiding this comment.
Maybe we should say not recommended or mention it causes data loss
There was a problem hiding this comment.
People who build fennecProduction won't have access to Mozilla's signing keys so the would not be able to pave over their Fennec release install.
There was a problem hiding this comment.
That's right. It will only work on top of their own build of Fennec, not ours.
There was a problem hiding this comment.
I'll add the data loss warning, since people have been messing with it on Reddit.
colintheshots
force-pushed
the
updateDocs
branch
from
b49e09d
to
014c517
Compare
colintheshots
force-pushed
the
updateDocs
branch
from
014c517
to
9cb5e06
Compare
| 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. |
There was a problem hiding this comment.
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).
Pull Request checklist
After merge