Skip to content

Commit 491d127

Browse files
authored
Merge pull request #50921 from jabrena/feature/devcontainers-docs-strikes-backs
Adding missing documentation about the purpose of Devcontainers's support
2 parents 87188d2 + 785e252 commit 491d127

File tree

2 files changed

+41
-0
lines changed

2 files changed

+41
-0
lines changed

.devcontainer/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Devcontainers support for Quarkus
2+
3+
## Motivation
4+
5+
Sometimes, you don´t have the right dev environment to explore and contribute in the `Quarkus`project. With this idea in Mind, `Devcontainers` was added to use the capabilities from Cloud Environments like `Github Codespaces`.
6+
7+
**Note:** Not use in local DevContainer with Quarkus because it is massive and you are adding another abstraction layer.
8+
9+
## Getting Started
10+
11+
If you visit the project in Github: https://github.com/quarkusio/quarkus in the main view, exist a Green button named `Code` if you click in the dropdown, you will see the option `Codespaces` so, if you click in the button `Open in Codespaces`, you will open a new Tab in your web browser to load Quarkus in Codespaces.
12+
13+
## Benefits
14+
15+
Quarkus project has plenty extensions, if you are interesting to review any extension, you could use DevContainers to review in an easy & quick way.
16+
17+
**Examples:**
18+
19+
```bash
20+
#High performance Data Structures
21+
./mvnw clean verify -pl extensions/agroal -am
22+
23+
#Dependency Injection Engine in Quarkus
24+
./mvnw clean verify -pl extensions/arc -am
25+
26+
#Devservices
27+
./mvnw clean verify -pl extensions/devservices -am
28+
29+
#Panache
30+
./mvnw clean verify -pl extensions/panache -am
31+
```
32+
33+
Enjoy!
34+
35+
## References
36+
37+
- https://containers.dev/
38+
- https://github.com/features/codespaces
39+
- https://github.com/codespaces

.github/workflows/ci-sanity-check.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ on:
1616
- '.github/*.java'
1717
- '.github/*.conf'
1818
- '.sdkmanrc'
19+
- '.devcontainer/**'
1920
pull_request:
2021
paths:
2122
- '.gitignore'
@@ -30,6 +31,7 @@ on:
3031
- '.github/*.java'
3132
- '.github/*.conf'
3233
- '.sdkmanrc'
34+
- '.devcontainer/**'
3335

3436
jobs:
3537
ci-sanity-check:

0 commit comments

Comments
 (0)