Update `./mach doctor` to check for erroneously enabled Artifact Builds
Categories
(Firefox Build System :: Mach Core, enhancement, P3)
Tracking
(firefox102 fixed)
| Tracking | Status | |
|---|---|---|
| firefox102 | --- | fixed |
People
(Reporter: ahochheiden, Assigned: ahochheiden)
References
Details
Attachments
(1 file)
Discussion regarding the 'onboarding footgun' of Artifact Builds comes up once in a while on Matrix, and sometimes on Bugzilla.
There's no perfect solution to this problem. We need a reasonable default, and Artifact Builds being default makes sense. The 'error' of having an Artifact Build enabled, but not wanting it, is visible. The code doesn't compile, the developer loses some time, but they eventually figure it out and disable Artifact Builds (otherwise they will never proceed).
If Artifact Builds weren't default, the 'error' of not enabling them when you should is 'silent'. The builds for that developer just take much longer when they don't have to, but there's nothing to indicate to the developer that there's a problem with their config, since their build will still succeed (eventually).
I had the idea of using VCS to check for local modified files that get compiled. If Artifact Builds are enabled, and you're changing compiled files, you're probably in a misconfigured state. This works, and I ran it by Glandium, but he was concerned with the overhead of using VCS to get modified files. If we do it during the build, we always add that overhead, and it could take a significant amount of time, every time a build is ran.
As a compromise, I added the same check, but to ./mach doctor. There's still somewhat of a tribal knowledge gap (you have to know about ./mach doctor to be able to fix your misconfigured build), but hopefully by continuing to add features to ./mach doctor it will be more commonplace to suggest is as the first troubleshooting step.
|
Assignee | |
Comment 1•2 years ago
|
||
Pushed by ahochheiden@mozilla.com: https://hg.mozilla.org/integration/autoland/rev/f1ab327bed3a Updated `./mach doctor` to check for erroneously enabled Artifact Builds r=sheehan
|
||
Comment 3•2 years ago
|
||
| bugherder | ||
Description
•