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.

Sign up for GitHub

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

Jump to bottom

DOC: extending README.md with the development section #61

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DOC: extending README.md with the development section #61

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,3 +138,22 @@ and under the GitHub settings add
```
where `owner` is the GitHub user/org,
and `repository` is the name of the repository you want to open.

## Development

For a development install, do the following in the repository directory:

```bash
jlpm install
jlpm run build
jupyter labextension link .
```

You can then run JupyterLab in developer mode to automatically pick up changes
to `@jupyterlab/github`. Launch JupyterLab using
```bash
jupyter lab --watch
```
This will automatically recompile `@jupyterlab/github` upon changes, and
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The jupyter lab --watch process won't automatically recompile the extension typescript sources, it instead watches the built JS. So you still need to watch or recompile the extension for JupyterLab to pick up the changes.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review, @ian-r-rose! What would you recommend then? jupyter lab --watch --dev-mode? Or another step for recompilation?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not --dev-mode (which will run JupyterLab from master without extensions). Instead we can start a watch process in the jupyterlab-github directory (jlpm run watch), which will recompile the extension at the same time as the jupyter lab --watch process is going on, which will then pick up the changes to the compiled sources.

JupyterLab will rebuild itself. You should then be able to refresh the page and
see your changes.