Add support for devcontainers. #6
Conversation
|
Testing this out, noticed the qmk firmware folder. We might want to handle the qmk_firmware directory better. Eg, init it as a submodule or add it to gitignore, or something. |
|
@drashna how about now? Not sold on the new code workspace file being created, but it allows for both qmk_userspace and qmk_firmware in the sidebar. |
|
It looks like the code workspace doesn't get loaded unless you manually load it. Which, you could just add a folder to the workspace, anyways. And a short look shows that there isn't a good solution for this :/ I'd say just opt to not add the workspace creation. |
…qmk/qmk_firmware.
|
Yeah I came to the same conclusion. I've removed the automatic workspace generation, and sync'ed up the VSCode extensions with qmk/qmk_firmware. |
.devcontainer/devcontainer.json
Outdated
| "xaver.clang-format", | ||
| "llvm-vs-code-extensions.vscode-clangd", | ||
| "bierner.github-markdown-preview", | ||
| "donjayamanne.git-extension-pack" |
There was a problem hiding this comment.
VS Code recommended the dev/remote containers extension on first setup, for me. Not sure if we want/need it here.
"ms-vscode-remote.remote-containers"
Updated `.gitignore`. Point workflows at `qmk/.github`s `main` branch (qmk#1) Add support for devcontainers. (qmk#6) Replicate qmk/qmk_firmware#23310 use containerWorkspaceFolder var and pass it to setup.sh (qmk#12) - folder name inside dev container is same as folder name on host so if it differs from qmk_userspace then setup.sh cannot be found and it sets incorrect user.overlay_dir - docs https://containers.dev/implementors/json_reference/ Add `qmk config user.overlay_dir` step to README.md (qmk#23) Removes duplicated word *with* in README.md (qmk#29) Add clangd-related entries to `.gitignore` (qmk#31) This is needed to support VS Code with clangd for userspace keymaps (in this case `compile_commands.json` and `.cache/clangd` are located in the `qmk_userspace` working copy).
Description
Creation command is a bit long, but it does the job.
Allows for the use of GitHub Codespaces to do compilation online, rather than setting up a local environment.