devsurface 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.3.0
+
+- Added the reusable `mrfandu1/devsurface@v0` GitHub Action.
+- Added static repository checks for onboarding documentation, scripts, configuration,
+  environment setup, and declared ports.
+- Added workflow annotations, job summaries, optional update-in-place pull request
+  comments, and configurable failure thresholds.
+- Added safe fallback behavior when fork pull requests have read-only tokens.
+- Added Docker Compose service status with running, stopped, error, and unavailable states.
+- Added dashboard controls to start and stop individual Compose services.
+- Added bounded per-service Docker Compose logs in the Services view.
+- Added Docker Desktop guidance when the engine is not responding on macOS or Windows.
+- Reduced consumer-installed dependencies by bundling the browser opener and keeping
+  React build-only.
+
 ## 0.2.0
 
 - Added retained process logs through `GET /api/logs` so the dashboard can recover session output without relying only on WebSocket state.

package/README.md

@@ -117,6 +117,50 @@ Run DevSurface without installing it globally:
 | `devsurface init`         | Create a starter `devsurface.config.json`.                           |
 | `devsurface run <script>` | Run a package script and stream output.                              |
 
+## GitHub Action
+
+DevSurface can check repository onboarding health on every pull request without
+installing dependencies or running project scripts.
+
+```yaml
+name: DevSurface
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  health:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: mrfandu1/devsurface@v0
+        with:
+          fail-on: error
+```
+
+The action always emits workflow annotations and a Markdown job summary. On pull
+requests it also creates or updates one DevSurface comment when the workflow token
+has `pull-requests: write`. Fork pull requests normally receive a read-only token;
+in that case the action keeps the annotations and summary and skips the comment.
+
+Inputs:
+
+| Input          | Default | Description                                                     |
+| -------------- | ------- | --------------------------------------------------------------- |
+| `path`         | `.`     | Repository-relative directory to check.                         |
+| `fail-on`      | `error` | Fail on `error`, `warning`, or never fail with `never`.         |
+| `comment`      | `true`  | Create or update a pull request comment when permissions allow. |
+| `github-token` | token   | Token used only for pull request comments.                      |
+
+The repository checks are intentionally static. They do not install dependencies,
+run package scripts, inspect local ports, require a real `.env`, or contact Docker.
+
 ## What It Detects
 
 | Area            | Detection                                                          |
@@ -126,7 +170,7 @@ Run DevSurface without installing it globally:
 | Scripts         | `package.json` scripts                                             |
 | Environment     | `.env`, `.env.example`, missing and empty keys without values      |
 | Ports           | Configured, inferred, and occupied ports using Node's `net` module |
-| Docker          | Compose files, Docker daemon status, compose service names         |
+| Docker          | Compose files, daemon status, service state, controls, and logs    |
 | Git             | Repository presence and current branch                             |
 | Framework       | Next.js, Vite, Express, Fastify, NestJS, Remix, Prisma             |
 
@@ -141,7 +185,8 @@ The dashboard includes:
 - **Scripts**: every package script, plus grouped configured commands when present.
 - **Environment**: `.env` and `.env.example` status, key presence, and copy-from-example.
 - **Ports**: detected ports with availability and conflict warnings.
-- **Services**: Docker Compose detection and service status.
+- **Services**: Docker Compose daemon state, per-service status, start/stop controls,
+  and the latest 200 log lines for each service.
 - **Logs**: expandable per-command logs with timestamps, streams, and exit state.
 - **Repo Health**: doctor warnings for common setup issues.
 
@@ -203,6 +248,7 @@ DevSurface is designed for local development.
 - Mutating API routes require dashboard intent headers.
 - `.env` values are never returned by scanners, API routes, CLI output, or UI panels.
 - Dashboard command runs show the exact command string first.
+- Docker service start and stop actions show the exact Compose command before running.
 - Destructive-looking configured commands, such as `rm -rf`, `docker volume rm`,
   database drops, and `git clean -fd`, are visibly marked before execution.
 - Child processes started by DevSurface are cleaned up when the dashboard exits.