[Documentation] running the debugger as part of a firefox build#3174
Conversation
Codecov Report
@@ Coverage Diff @@
## master #3174 +/- ##
=======================================
Coverage 47.59% 47.59%
=======================================
Files 97 97
Lines 4036 4036
Branches 828 828
=======================================
Hits 1921 1921
Misses 2115 2115Continue to review full report at Codecov.
|
|
Reading through this now! @codehag thanks so much for doing this, it's been something we've been needing. 😄 |
|
|
||
| ## Getting Started with Firefox Nightly | ||
|
|
||
| Running firefox is similar to running [Mochitests](./mochitests.md) |
There was a problem hiding this comment.
Minor nit: capitalize Firefox.
There was a problem hiding this comment.
Perhaps:
similar to running Mochitests (our integration tests)
wldcordeiro
left a comment
There was a problem hiding this comment.
Love it! The writing is great, simple and informative.
|
|
||
| ## Getting Started with Firefox Nightly | ||
|
|
||
| Running firefox is similar to running [Mochitests](./mochitests.md) |
There was a problem hiding this comment.
Perhaps:
similar to running Mochitests (our integration tests)
| There are two commands that you will need. `./mach build` and `./mach run` these can be run together | ||
| each time things change with `./mach build && ./mach run` | ||
|
|
||
| * The first time you run the project you will need to use `./mach build` but after the first run you can use `./mach build faster`! The full command looks like this`./mach build faster && ./mach run` |
There was a problem hiding this comment.
lets link to docs: https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/mach
I'd rather people learn about edge cases there!
| On the first run, this will download a local copy of Firefox and set up an [artifact build](https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/Artifact_builds) (just think of a super fast Firefox build). It may take a while (10-15 minutes) to download and build Firefox. | ||
|
|
||
| There are two commands that you will need. `./mach build` and `./mach run` these can be run together | ||
| each time things change with `./mach build && ./mach run` |
There was a problem hiding this comment.
should we mention clobber?
| in npm: | ||
| ``` | ||
| npm run copy-assets | ||
| ``` |
There was a problem hiding this comment.
lets leave out the npm flavor. I think we should expect people to be able to convert btw the two
| It's annoying to have to manually update the bundle every single time though. If you want to automatically update the bundle in Firefox whenever you make a change, run this: | ||
|
|
||
| ``` | ||
| npm run copy-assets-watch |
| Now we can put these pieces together. After you copy over the assets, you can run firefox with the | ||
| debugger inside the panel! | ||
|
|
||
| in debugger project (`projects/debugger.html` or whereever you have it!): |
|
|
||
| in debugger project (`projects/debugger.html` or whereever you have it!): | ||
| ``` | ||
| npm run copy-assets-watch |
|
|
||
| You can change this to what works for you! | ||
|
|
||
| ## Watching for Changes |
There was a problem hiding this comment.
It might be nice to move## Running Nightly with the local debugger up higher.
I could see moving some of this extra info to an Appendix, which gives people extra info without distracting them from the primary task, which is seeing their version of the debugger in FF!
Associated Issue: #3169
Add documentation about how to run as a panel