Where does Android Studio save the ProGuard mapping file?

Question

In Android Studio, where are the ProGuard mapping files generated after compiling a signed APK?

I'm not sure if it isn't working or if I just forgot the file path, and my compulsory Google/Stack Overflow search did not answer this

it is explained here officially https://firebase.google.com/docs/crash/android#uploading_proguard_mapping_files_manually — Jayakrishnan, Jun 22 '17 at 13:18
@JayakrishnanPM glad to see Google got around to it 3 years later. — CQM, Jun 22 '17 at 16:54

score 322 · Accepted Answer · edited Mar 05 '18 at 22:30

322

It should be located at build/outputs/proguard/release/mapping.txt in your application module's directory.

In the latest version of ProGuard and Android Studio, the file is located at build/outputs/mapping/release/mapping.txt.

edited Mar 05 '18 at 22:30

hungryghost

9,463
3
23
36

answered Sep 08 '14 at 20:37

Scott Barta

79,344
24
180
163

5

More information about the generated files and path: https://developer.android.com/studio/build/shrink-code.html – Helton Isac Apr 07 '18 at 14:34
If your **Instant Run** is enabled, you may not be able to see mapping file. Disable Instant Run and build again. – Faizan Mubasher Aug 17 '19 at 07:14
1

After an update to Gradle 6.2.2/Gradle Plugin 3.6.1 the paths changed for us. `/app/build/outputs/mapping/brandExampleEnvProductionRelease/mapping.txt` `/app/build/outputs/mapping/brandExampleEnvIntegrationBeta/mapping.txt` are the new paths. – Carsten Hagemann Mar 13 '20 at 14:32
4

UPDATE: As of AS 4.1.1 , Gradle plugin 4.0.2 , Gradle 6.1.1 , you need to have ```minifyEnabled true``` to get mapping.txt inside the ```build/outputs/mapping//mapping.txt``` – HX_unbanned Nov 26 '20 at 13:25
how to add this path in bitrise.yml file? – Viks Aug 30 '21 at 01:14

score 79 · Answer 2 · edited Sep 12 '18 at 08:58

79

For me they are at 'build/outputs/mapping/release'

edited Sep 12 '18 at 08:58

AskNilesh

67,701
16
123
163

answered Dec 29 '14 at 14:17

Tom

2,242
18
27

18

'build/outputs/mapping/release/mapping.txt' – aleb Jan 20 '15 at 15:01
1

Yes that one is perfect for android studio 2.3.2 – Subho May 10 '17 at 12:48
1

app/build/outputs/mapping/release/mapping.txt bc there was a separate build folder that did not contain the mapping file... – NukeouT Sep 27 '17 at 18:16

score 43 · Answer 3 · edited May 23 '17 at 12:34

43

I found it cleaner to configure proguard to write the mapping.txt file to a location outside of the build/ directory tree, so that it could be more conveniently checked into version control.

To achieve this, put this in your proguard-rules.pro file:

-printmapping mapping.txt

This will (most likely) place it in the same directory as your proguard-rules.pro file. Ultimately, you probably want to write it to the same directory as your APK file and with an equivalent name (which might include flavor, build type etc).

Note: in my experience, this is not overruled by the proguard template file (which was suggested by a commenter to another answer here).

UPDATE: If you have multiple product flavors, then this is a much better solution: https://stackoverflow.com/a/31116608/444761

edited May 23 '17 at 12:34

Community

1
1

answered Mar 19 '15 at 10:08

Mark

7,446
5
55
75

1

This is better than my solution, as like you say you can then place it under version control. – Clive Jefferies Mar 31 '15 at 10:39
why would you like to version control this one? you need it for every APK you release seperately as it is build dependant. as you have to upload / checkin such an apk seperately from source there is actually no need to check it in the source VCS!? – Denny1989 Jul 03 '15 at 12:17
@Denny1989 not sure what you mean. I build an APK and store it outside version control. I have to keep the mapping file somewhere. I *could* store it alongside the APK, but I find it cleaner to version control it. However, I only have one release APK per project so YMMV. – Mark Jul 03 '15 at 16:19

score 40 · Answer 4 · answered Feb 10 '15 at 12:24

40

I found that it was not being generated, so I added this to the rules file

-printmapping build/outputs/mapping/release/mapping.txt

answered Feb 10 '15 at 12:24

Clive Jefferies

1,138
14
26

1

I found that printmapping was overruled by a template proguard file I was using! – Boy Mar 11 '15 at 15:07
1

this worked and generated all the proguard output files for me. – j2emanue Nov 30 '16 at 16:58
3

Still no mapping directory. Maybe it's because V8 ignores progurad now? How to generate it with V8? – Csaba Toth Sep 05 '20 at 08:12

score 19 · Answer 5 · edited Nov 14 '17 at 23:50

Its quite late to answer this question but just in case someone need my answer.

Location of Mapping file to deobfuscate:

ProGuard saves the file in the app app/build/outputs/mapping/FLAVOR/release/mapping.txt

Generally in debug mode you don't need the mapping file because there generally obfuscation is disabled. If it is not that case then make sure in build.gradle file you have below code for debug variant.

debug {
    minifyEnabled false
    debuggable true
}

Some Gotchas:

mapping.txt file gets overwritten every time you create a release build with ProGuard, so first take backup of that file before creating a new release. It will help to obfuscated stack trace from an older version of your app.

Apart from that there are two ways to obfuscate your code :

1. Upload your mapping.txt file to Google play Console:

When publishing your app on Google Play, you can upload the mapping.txt file for each version of your APK. Then Google Play will deobfuscate incoming stack traces from user-reported issues so you can review them in the Google Play Console.

2. Use local sdk tool retrace.sh/retrace.bat:

Some times you want to run the release version of your app(by changing build variant to release and running it) to cross check and fix the errors so that it does not happens in production ( when released to play-store).

To convert an obfuscated stack-trace to a readable one yourself, use the retrace script (retrace.bat on Windows; retrace.sh on Mac/Linux).

It is located in the <sdk-root>/tools/proguard/bin/ directory.

<sdk-root> is the place where your all android libraries and sdks were installed.

The script takes the mapping.txt file and your stack trace, producing a new, readable stack trace.

Command Syntax:

retrace.bat|retrace.sh [-verbose] mapping.txt [<stacktrace_file>]

For example:

retrace.bat -verbose mapping.txt obfuscated_trace.txt

I prefer local version of obfuscating as is quite handy to pre-check production errors.

I hope it helps.

score 13 · Answer 6 · answered Aug 02 '16 at 19:02

13

Here it is in a picture - you will find it in the mapping folder:

answered Aug 02 '16 at 19:02

Simon

19,658
27
149
217

score 12 · Answer 7 · answered Nov 20 '16 at 11:02

12

I am using version Android Studio 2.2.2. For me it's located in the following locations:

For debug: \app\build\outputs\mapping\debug\mapping.txt

For release: \app\build\outputs\mapping\release\mapping.txt

answered Nov 20 '16 at 11:02

Faisal Shaikh

3,900
5
40
77

score 5 · Answer 8 · answered Feb 24 '21 at 12:47

5

If anyone is still searching for mapping.txt:

minifyEnabled in build.gradle has to be set to true

I'm using Android Studio 4.2 Beta 4 and the standard-setting was false.

If minifyEnable is set to false the build is not "minified", so a mapping-file is of course not necessary, but google-play-console asks for the mapping file anyway.

... Very confusing for a beginner

answered Feb 24 '21 at 12:47

sascha4532

84
1
3

I used to think Apple's upload process was complicated unnecessarily, before Google garbage. – Hope Jan 25 '23 at 08:37

score 2 · Answer 9 · answered Sep 11 '16 at 17:11

2

Because I'm dumb and get lost even when somebody tells me where the file is:

cd StudioProjects/fooProject
find . -name "mapping.txt" | xargs less

answered Sep 11 '16 at 17:11

philo

3,580
3
29
40

score 1 · Answer 10 · answered May 30 '21 at 14:33

1

Proguard^[About] outputs are located

<module_name>/build/outputs/mapping/<buildType>/
//e.g.
/Users/alex/Desktop/MyProject/MyModule/build/outputs/mapping/releasefree

answered May 30 '21 at 14:33

yoAlex5

29,217
8
193
205

Where does Android Studio save the ProGuard mapping file?

10 Answers10

Linked

Related