Skip to content

Commit 9963808

Browse files
Flossyclaude
andcommitted
Update documentation: CHANGELOG and QUICKSTART
Updated documentation to reflect the complete feature set: CHANGELOG.md updates: - Updated test count from 52 to 70 tests across 9 test classes - Updated coverage from 45% to 39% (added more code, focus on API contracts) - Added NativeProcessLauncher and ContainerLauncher to test list - Added new Documentation section listing: - NATIVE_EXECUTION.md guide - CONTAINER_DEPLOYMENT.md guide - jplatform-core/README.md module docs - Updated main README.md - Complete Javadoc for all new classes QUICKSTART.md updates: - Added new "Deployment Modes" section with three modes: 1. JVM Applications (default) 2. Native Processes (GraalVM, compiled binaries) 3. Containers (Docker/Podman/LXC) - Example YAML descriptors for each deployment mode - Links to detailed documentation (NATIVE_EXECUTION.md, CONTAINER_DEPLOYMENT.md) - Updated "Next Steps" section with links to new guides All documentation now accurately reflects: - 70 unit tests (all passing) - Three deployment modes supported - Complete feature documentation - Javadoc coverage on all classes Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 78bd194 commit 9963808

2 files changed

Lines changed: 63 additions & 2 deletions

File tree

CHANGELOG.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,17 @@ and this project adheres to X.Y semantic versioning.
4343
- Added comprehensive unit tests for jplatform-core module
4444
- Created ApplicationManagerConcurrencyTest to verify fine-grained locking
4545
- Added tests for DependencyResolver, ApplicationReloader, NativeLibraryLoader, ClassLoaderVersion
46-
- Increased test coverage from minimal to 45% instruction coverage
47-
- Total of 52 unit tests across 7 test classes
46+
- Added tests for NativeProcessLauncher and ContainerLauncher
47+
- Test coverage at 39% instruction coverage (70 tests across 9 test classes)
48+
- Focus on API contracts and configuration validation
49+
- Integration tests require actual executables/containers
50+
51+
### Documentation
52+
- NATIVE_EXECUTION.md - Complete guide to native process deployment (GraalVM, Rust, Go, C++)
53+
- CONTAINER_DEPLOYMENT.md - Complete guide to container orchestration (Docker/Podman/LXC)
54+
- jplatform-core/README.md - Module documentation with all components and deployment modes
55+
- Updated README.md with native execution and container orchestration features
56+
- All classes have complete Javadoc (NativeProcessLauncher, ContainerLauncher)
4857

4958
### Changed
5059
- CI/CD pipeline now active with automated version bumping and artifact publishing

QUICKSTART.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -311,9 +311,61 @@ Command-line flags override configuration file settings:
311311
java -jar jplatform-launcher-1.0.jar --config platform.yaml --port 9000
312312
```
313313

314+
## Deployment Modes
315+
316+
JPlatform supports three deployment modes:
317+
318+
### 1. JVM Applications (Default)
319+
320+
Standard Java applications running in isolated classloaders:
321+
322+
```yaml
323+
applicationId: my-java-app
324+
mainClass: com.example.MyApp
325+
classpathEntries:
326+
- file:///path/to/app.jar
327+
```
328+
329+
### 2. Native Processes
330+
331+
Deploy GraalVM native images or compiled executables:
332+
333+
```yaml
334+
applicationId: graal-app
335+
nativeImage: true
336+
classpathEntries:
337+
- file:///usr/local/bin/myapp
338+
339+
properties:
340+
native.args: "--server --port=8080"
341+
native.env.DATABASE_URL: "jdbc:postgresql://db/app"
342+
native.workdir: "/var/apps/graal-app"
343+
```
344+
345+
See [NATIVE_EXECUTION.md](NATIVE_EXECUTION.md) for details.
346+
347+
### 3. Containers
348+
349+
Deploy applications as Docker, Podman, or LXC containers:
350+
351+
```yaml
352+
applicationId: web-server
353+
properties:
354+
container.runtime: docker
355+
container.image: nginx:alpine
356+
container.ports: "8080:80,8443:443"
357+
container.volumes: "/var/www:/usr/share/nginx/html"
358+
container.network: bridge
359+
container.env.NGINX_HOST: example.com
360+
```
361+
362+
See [CONTAINER_DEPLOYMENT.md](CONTAINER_DEPLOYMENT.md) for details.
363+
314364
## Next Steps
315365
316366
- Read the [README](README.md) for architecture details
367+
- Learn about [Native Execution](NATIVE_EXECUTION.md) - GraalVM and compiled binaries
368+
- Learn about [Container Deployment](CONTAINER_DEPLOYMENT.md) - Docker/Podman/LXC
317369
- Check [examples/applications](examples/applications) for sample descriptors
318370
- Explore sample applications in [jplatform-samples](jplatform-samples)
319371
- Review API documentation in [jplatform-api](jplatform-api)

0 commit comments

Comments
 (0)