Skip to content

Commit 37032fa

Browse files
committed
feat (docs): Clarify state of Development Containers support
1 parent ed73e29 commit 37032fa

File tree

3 files changed

+23
-3
lines changed

3 files changed

+23
-3
lines changed

.github/workflows/ci.yaml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,14 @@ concurrency:
3434

3535
jobs:
3636
devcontainer:
37-
# https://github.com/orgs/community/discussions/25722
3837
if:
3938
(github.repository == 'enola-dev/enola') &&
4039
(github.event.pull_request.draft == false)
4140
runs-on: ubuntu-latest
4241
steps:
4342
- uses: actions/checkout@v4
4443
- name: DevContainer
45-
# TODO if: ${{ github.event_name == 'push' }}
44+
# if: ${{ github.event_name == 'push' }}
4645
uses: devcontainers/[email protected]
4746
with:
4847
# TODO imageName: ghcr.io/example/example-devcontainer
@@ -53,7 +52,6 @@ jobs:
5352
# TODO runCmd: ./tools/test-ci/test.bash
5453

5554
build:
56-
# https://github.com/orgs/community/discussions/25722
5755
if:
5856
(github.repository == 'enola-dev/enola') &&
5957
(github.event.pull_request.draft == false)

docs/dev/ide.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,13 @@
2020

2121
Ensure you are [set-up](setup.md) with a working build on the CLI before configuring your IDE.
2222

23+
!!! failure "VSC broken for Java development"
24+
25+
[Use only IntelliJ](#jetbrains-intellij-idea-ij) for Java development, until
26+
[bazel-vscode-java#114](https://github.com/salesforce/bazel-vscode-java/issues/114) is fixed.
27+
28+
For `web/` development, and documentation writing, you can still use VSC etc.
29+
2330
## GitHub Codespaces
2431

2532
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/enola-dev/enola?quickstart=1)

docs/dev/setup.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,21 @@
1818

1919
# Dev Set-Up
2020

21+
## DevContainers
22+
23+
This project [aims to](https://github.com/enola-dev/enola/issues/180) eventually (only) use & support [Development Containers](https://containers.dev/). The current state is:
24+
25+
* For Doc & Web, [not Java](https://github.com/salesforce/bazel-vscode-java/issues/114), with VSC-based:
26+
* GitHub CodeSpaces works (?)
27+
* Visual Studio Code with [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) works on Ubuntu (?), but [not Fedora](https://github.com/microsoft/vscode-remote-release/issues/10681)
28+
* JetBrains Family
29+
* On Fedora, use IntelliJ IDEA 2025.1 EAP instead of 2024.3.2.2, due to [IJPL-173883](https://youtrack.jetbrains.com/issue/IJPL-173883)
30+
* TODO File IntelliJ bug re. _"sh: 1: /workspaces/enola/tools/devcontainer/install.bash: not found"_ problem?
31+
* https://devpod.sh:
32+
* [Broken](https://github.com/enola-dev/enola/issues/1038) TODO Debug...
33+
* [AppImage does not work on Fedora 41](https://github.com/loft-sh/devpod/issues/1410); TODO Try Targz!
34+
* There is some CI "coverage", which would detect major problems, but cannot catch problems such as those listed above.
35+
2136
## GitHub Codespaces
2237

2338
**We highly recommend you use our ready-made "1 click" [Web/Cloud IDE](ide.md) set-up.**

0 commit comments

Comments
 (0)