Create devcontainer.json #13520

bam80 · 2023-09-23T21:19:07Z

Maintainer: me
Compile tested: mips, ath79, OpenWrt SNAPSHOT

Description:
Development container configuration.
The container can run locally or in cloud (Codespaces).
Sample usage: easily open full-featured VS Code IDE in browser, pre-configured for OpenWrt firmware/packages development.

Signed-off-by: Andrey Butirsky butirsky@gmail.com

john-tho · 2023-09-24T00:06:44Z

in cloud (Codespaces)
in browser

Could you please give examples of what benefits this might provide? Which target SDK does this use? How does it help users do runtime testing of the changes they are proposing?

If this encourages more users to submit PRs via GitHub's web development tools, could we please hold off until GitHub can work with a rebase workflow? Advising users to squash, reword, or not to spam PRs to update is not productive for anyone, this week's example: #13486 (comment)

bam80 · 2023-10-02T22:59:41Z

Could you please give examples of what benefits this might provide?

For example, it allows one who has no local dev setup or doesn't want to checkout code locally still participate in the OpenWrt/packages development.
It also provides better code navigation, as VS Code does it better than Github.

Which target SDK does this use?

The SDK is generated from this repository:
https://github.com/openwrt/docker#sdk
You can see possible targets here:
https://hub.docker.com/r/openwrt/sdk/tags

In my test, by default it compiled a package for mips, ath79.

How does it help users do runtime testing of the changes they are proposing?

Users can download the compiled images/packages from the container locally for the tests.

If this encourages more users to submit PRs via GitHub's web development tools, could we please hold off until GitHub can work with a rebase workflow?

I don't think this encourages more GitHub's web development tools usage.
Rather makes the Green Button do the right thing, as it exists anyway.
The container has full CLI access to the official OpenWrt SDK, which includes mainstream git tools to make a PRs.

So I would say this doesn't harm anything, but can be extremely useful.
Probably no reasons to block it.

ynezz

LGTM. Unless someone beats me to it, I'll leave it here for next two weeks so it gets a chance for review and then merge this myself.

bam80 · 2023-10-18T15:37:20Z

@ynezz ping please?

.devcontainer/devcontainer.json

hauke · 2023-10-29T15:35:03Z

Why do you use the OpenWrt SDK container?
When I use the default code space environment I am able to build OpenWrt inside the system.

I added a codespace container to build OpenWrt using the SDK: https://github.com/hauke/openwrt/blob/codespace/.devcontainer/ci-env/devcontainer.json
This helped me some time ago to debug build problems seen only in the SDK.

Maintainer: me Compile tested: mips, ath79, OpenWrt SNAPSHOT Description: Development container configuration. The container can run locally or in cloud (Codespaces). Sample usage: easily open full-featured VS Code IDE in browser, pre-configured for OpenWrt firmware/packages development. Signed-off-by: Andrey Butirsky <butirsky@gmail.com>

bam80 · 2023-10-30T12:40:01Z

Why do you use the OpenWrt SDK container?
When I use the default code space environment I am able to build OpenWrt inside the system.

Can you cross-compile with the default code space environment, out of the box?
While the default code space environment might work for you at the moment, it can change at any time, whereas OpenWrt SDK is the official reference thing for OpenWrt, so we are better stick to it.

ynezz · 2023-10-30T14:46:39Z

Can you cross-compile with the default code space environment, out of the box?

IMO (and if its possible) we should allow both use cases. Any idea how to achieve that? Maybe we should consider ImageBuilder containers in the mix? So we could've codespace for system build, package build with SDK and image builder.

Which target SDK does this use?

Good point, how to handle this? Is it possible to have some kind of a list for each platform we support?

bam80 · 2023-10-30T15:42:43Z

@ynezz right now, if we merge both this and #13825, the list of the both container configurations should be presented (but I didn't test it).

The same way we could handle all the others platforms, making separate devcontainer.json for each.
From there, we could reference different platforms SDKs by tag:
https://hub.docker.com/r/openwrt/sdk/tags

I'm not sure how maintainable that galore of devcontainer.json would be, though.

ynezz · 2023-10-30T20:24:14Z

the list of the both container configurations should be presented (but I didn't test it).

Seems to work fine, even with all SDK containers.

I'm not sure how maintainable that galore of devcontainer.json would be, though.

We could add script to generate those ynezz@9d22687

bam80 · 2023-10-30T21:46:32Z

Seems to work fine, even with all SDK containers.

It probably has no point to generate the .json's for all SDK versions in the master branch.
Those for other versions could go to respective branches, if we need them at all.

bam80 · 2023-10-30T22:20:25Z

We could add script to generate those ynezz@9d22687

It looks like Dev Container Templates provide better answer for this, see

     "image": "mcr.microsoft.com/devcontainers/java:0-${templateOption:imageVariant}",

in the .devcontainer.json example:
https://containers.dev/implementors/templates/#option-resolution-example

@ynezz could we have a similar script but to generate imageVariant, etc. template options for devcontainer-template.json instead?
See the example above.

The options would be
target, subtarget, branch|tag|version as per:
https://github.com/openwrt/docker#sdk-tags

Having that, here is a guide for creating our own custom Dev Container Templates:
https://github.com/devcontainers/template-starter

UPDATE:
the script should probably be on the OpenWrt docker repo side, somewhere here:
https://github.com/openwrt/docker/blob/main/.github/workflows/containers.yml#L150

I also created a relevant issue there:
openwrt/docker#126

hauke · 2023-10-30T22:33:47Z

having all SDKs available here would be nice. I agree we should only show the master SDKs in master and add the others to the other branches.

The template looks very nice. Does the template work with github? The github devcontainer documentation does not mention it.

bam80 · 2023-10-31T12:04:04Z

having all SDKs available here would be nice.

Addressing it on OpenWrt docker repo side should guarantee this and I think overall better as there is already all the Tags parsing needed there:
openwrt/docker#126

The template looks very nice. Does the template work with github? The github devcontainer documentation does not mention it.

Looks like it does. Worst thing I can imagine the template won't be applied for our repo automagically, and user has to select the OpenWrt SDK Template from a filterable list displayed on the GitHub Codespaces or on the VS Code Dev Containers UI:
https://code.visualstudio.com/docs/devcontainers/containers#_quick-start-open-an-existing-folder-in-a-container

But that needs to be tested, it might be there is some logic to display most appropriate templates for the repo on the top of the list, or something like that.

Anyway, it seems the way to go forward.

bam80 · 2024-05-22T18:34:47Z

@ynezz right now, if we merge both this and #13825, the list of the both container configurations should be presented

Friendly ping.
The patch suggested is useful as is, and it's simple.
Could we merge it to have something, and then iterate from that, please?

bam80 · 2024-06-16T21:49:32Z

Ping, please

bam80 · 2024-06-26T18:43:49Z

@hauke ping, please

bam80 force-pushed the patch-1 branch from d389400 to 895d78a Compare September 23, 2023 21:28

bam80 mentioned this pull request Sep 23, 2023

Create devcontainer.json openwrt/packages#22196

Open

ynezz approved these changes Oct 3, 2023

View reviewed changes

hauke reviewed Oct 29, 2023

View reviewed changes

.devcontainer/devcontainer.json Outdated Show resolved Hide resolved

hauke mentioned this pull request Oct 29, 2023

devcontainer: Add development environment for gihub codespace #13825

Merged

bam80 force-pushed the patch-1 branch from 946cb58 to 8488327 Compare October 30, 2023 12:27

bam80 requested review from ynezz and hauke October 30, 2023 12:28

bam80 mentioned this pull request Oct 31, 2023

feature request: create and auto update Dev Container Templates repo openwrt/docker#126

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create devcontainer.json #13520

Create devcontainer.json #13520

bam80 commented Sep 23, 2023 •

edited

Loading

john-tho commented Sep 24, 2023

bam80 commented Oct 2, 2023 •

edited

Loading

ynezz left a comment •

edited

Loading

bam80 commented Oct 18, 2023 •

edited

Loading

hauke commented Oct 29, 2023

bam80 commented Oct 30, 2023

ynezz commented Oct 30, 2023

bam80 commented Oct 30, 2023

ynezz commented Oct 30, 2023 •

edited

Loading

bam80 commented Oct 30, 2023

bam80 commented Oct 30, 2023 •

edited

Loading

hauke commented Oct 30, 2023

bam80 commented Oct 31, 2023 •

edited

Loading

bam80 commented May 22, 2024

bam80 commented Jun 16, 2024

bam80 commented Jun 26, 2024

Create devcontainer.json #13520

Are you sure you want to change the base?

Create devcontainer.json #13520

Conversation

bam80 commented Sep 23, 2023 • edited Loading

john-tho commented Sep 24, 2023

bam80 commented Oct 2, 2023 • edited Loading

ynezz left a comment • edited Loading

Choose a reason for hiding this comment

bam80 commented Oct 18, 2023 • edited Loading

hauke commented Oct 29, 2023

bam80 commented Oct 30, 2023

ynezz commented Oct 30, 2023

bam80 commented Oct 30, 2023

ynezz commented Oct 30, 2023 • edited Loading

bam80 commented Oct 30, 2023

bam80 commented Oct 30, 2023 • edited Loading

hauke commented Oct 30, 2023

bam80 commented Oct 31, 2023 • edited Loading

bam80 commented May 22, 2024

bam80 commented Jun 16, 2024

bam80 commented Jun 26, 2024

bam80 commented Sep 23, 2023 •

edited

Loading

bam80 commented Oct 2, 2023 •

edited

Loading

ynezz left a comment •

edited

Loading

bam80 commented Oct 18, 2023 •

edited

Loading

ynezz commented Oct 30, 2023 •

edited

Loading

bam80 commented Oct 30, 2023 •

edited

Loading

bam80 commented Oct 31, 2023 •

edited

Loading