Add devcontainer

[fcollonval]

References

Add dev container set up to ease development and on boarding.

Code changes

Add devcontainer definition and tune the docker set up to share it.

User-facing changes

None

Backwards-incompatible changes

None

[jupyterlab-probot]

Thanks for making a pull request to jupyterlab!
To try out this branch on binder, follow this link:

[fcollonval]

@trungleduc do you mind reviewing this? Especially to check I did not break the docker dev workflow?

[jtpio]

Maybe this will also help address some comments from this discussion: #13049

[jtpio]

not break the docker dev workflow?

Maybe there is a way to put this under test on CI?

[trungleduc]

not break the docker dev workflow?

Maybe there is a way to put this under test on CI?

the docker setup is tested https://github.com/jupyterlab/jupyterlab/actions/runs/8139526094

[trungleduc]

Thanks @fcollonval

[jtpio]

Thanks!

Looks like it needs a lint pass:

[jtpio]

Thanks!

[jtpio]

Maybe with the dev extra?

Suggested change

	"postCreateCommand": "micromamba run pip install -e .",
	"postCreateCommand": "micromamba run pip install -e \".[dev]\"",

[fcollonval]

That step is needed only to build the JavaScript assets. All python dependencies are stored in a dedicated layer:

# Install all python dependencies only with pip to maximize using its cache
RUN --mount=type=cache,target=/jupyterlab/pip-cache,uid=${NEW_MAMBA_USER_ID},gid=${NEW_MAMBA_USER_GID} \
    PIP_CACHE_DIR="/jupyterlab/pip-cache" SKIP_JUPYTER_BUILDER=1 micromamba run python -m pip install -e  ".[dev,docs,test]" && \
    cd / && \
    rm -rf /home/$MAMBA_USER/jupyterlab_cache

So no need for the extra there.

[jtpio]

Opening a Codespace from this PR seems to be working fine. Although the pip install -e . step takes quite a bit of time, but this is likely because the specs for the default (free) Codespace are quite low.

[fcollonval]

Opening a Codespace from this PR seems to be working fine. Although the pip install -e . step takes quite a bit of time, but this is likely because the specs for the default (free) Codespace are quite low.

I had the same impression. In the follow-up #15916, I plan to store the base docker image on the GitHub registry, in order to speed up the docker build through cache reuse (option build.cacheFrom).

[fcollonval]

@meeseeksdev please backport to 4.1.x

[fcollonval]

@meeseeksdev please backport to 4.0.x

[lumberbot-app]

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

1. Checkout backport branch and update it.

git checkout 4.0.x
git pull

2. Cherry pick the first parent branch of the this PR on top of the older branch:

git cherry-pick -x -m1 2267e0faf9ac12052815550084d3bbf2a7a545ca

3. You will likely have some merge/cherry-pick conflict here, fix them and commit:

git commit -am 'Backport PR #15909: Add devcontainer'

4. Push to a named branch:

git push YOURFORK 4.0.x:auto-backport-of-pr-15909-on-4.0.x

5. Create a PR against branch 4.0.x, I would have named this PR:

"Backport PR #15909 on branch 4.0.x (Add devcontainer)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.