Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bug 1735626: Phab extensions migration nits #2

Merged
merged 1 commit into from
Oct 14, 2021
Merged
Changes from all commits
Commits
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
Binary file added .github/docs/debug-settings.png

Unable to render rich display

Invalid image source.

Binary file added .github/docs/debugger.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/docs/listening-debugger.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/docs/mappings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/docs/phabricator-includes.png

Unable to render rich display

Invalid image source.

12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -71,19 +71,19 @@ PHPStorm as the example IDE, though any Xdebug-compatible app should work.
1. Uncheck the "Notify if debug session was finished without being paused" option so that PhpStorm doesn't
continually pop up a notification if web requests succeed without hitting a breakpoint. This allows background
requests (fetching resources, `bmo.feed` requests, etc) to function without triggering warnings.
![](docs/debug-settings.png)
![](.github/docs/debug-settings.png)
1. Configure your source mappings from your host's directories to your server's (docker container's) directories
1. It's recommended to have the `arcanist` and `phabricator` source code in your PHP's includes
so that you can step into (debug) and Intellisense the vendor code ![](docs/phabricator-includes.png)
so that you can step into (debug) and Intellisense the vendor code ![](.github/docs/phabricator-includes.png)
* This can be set up by cloning [phabricator](https://github.com/phacility/phabricator) and
[arcanist](https://github.com/phacility/arcanist), then checking out the appropriate commits as defined in
this repository's `Dockerfile`.
1. Create a new "server" configuration with the host as `phabricator.test` and the path mappings as shown below: ![](docs/mappings.png)
1. Create a new "server" configuration with the host as `phabricator.test` and the path mappings as shown below: ![](.github/docs/mappings.png)
1. Test your mappings
1. Enable the debugger in PhpStorm ![](docs/listening-debugger.png)
1. Enable the debugger in PhpStorm ![](.github/docs/listening-debugger.png)
1. Set a breakpoint in `LandoLinkEventListener`
1. Go to [`phabricator.test/D1`](http://phabricator.test/D1)
1. Your IDE should have stopped the control flow on your breakpoint and be showing you debugger details ![](docs/debugger.png)
1. Your IDE should have stopped the control flow on your breakpoint and be showing you debugger details ![](.github/docs/debugger.png)


##### My pages are no longer loading after enabling debugging!?
@@ -107,5 +107,5 @@ docker-compose -f docker-compose.yml -f docker-compose.bmo.yml exec phabdb mysql

## Support

To talk to the `phabricator-extensions` developers, you can join them on [Matrix](https://chat.mozilla.org/#/room/#conduit:mozilla.org).
To talk to the Mozilla `phabricator` developers, you can join them on [Matrix](https://chat.mozilla.org/#/room/#conduit:mozilla.org).

2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "mozilla/phabricator-extensions",
"name": "mozilla/phabricator",
"type": "project",
"require": {
"sentry/sentry": "^2.3",