Skip to content

Commit 5ba9365

Browse files
venkatarenduchintalaVenkata Subramani Renduchintala
andauthored
docs(tests): move 'Running CI locally' section to test/README.md (#26)
Co-authored-by: Venkata Subramani Renduchintala <venkatarenduchintala@pm.me>
1 parent d9b908c commit 5ba9365

2 files changed

Lines changed: 31 additions & 37 deletions

File tree

README.md

Lines changed: 1 addition & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -32,42 +32,7 @@ Plugin-specific mappings live in `lua/plugins/configs/`. LSP mappings are define
3232
3333
# Tests
3434
35-
See [`test/README.md`](test/README.md) for the full test suite documentation — scripts, fixtures and what each validates.
36-
37-
<br>
38-
39-
# Running the CI pipeline locally
40-
41-
The GitHub Actions workflow (`.github/workflows/validate.yml`) builds the devcontainer image and mounts the repo into it. You can reproduce this locally in two ways.
42-
43-
## Option 1 — Direct Docker (recommended for this config)
44-
45-
The most reliable local approach, since the workflow uses Docker-in-Docker internally:
46-
47-
```bash
48-
# Build the devcontainer image
49-
docker build -f .devcontainer/Dockerfile -t nvim-config:ci .
50-
51-
# Run the full validation suite
52-
docker run --rm \
53-
-e CI=true \
54-
-v "$(pwd):/home/dev/.config/nvim:ro" \
55-
nvim-config:ci \
56-
bash /home/dev/.config/nvim/test/ci_validate.sh
57-
```
58-
59-
The `-e CI=true` flag skips heavy binary downloads (LSP servers, DAP adapters) so the run completes in under 5 minutes.
60-
61-
## Option 2 — [act](https://github.com/nektos/act)
62-
63-
[act](https://github.com/nektos/act) runs GitHub Actions workflows locally using Docker. Install it via your package manager, then:
64-
65-
```bash
66-
# Run the validate job (mirrors what GitHub runs on push/PR)
67-
act push -j validate
68-
```
69-
70-
> **Note:** Because the workflow itself uses `docker/build-push-action`, `act` requires Docker-in-Docker. If the build step fails, fall back to Option 1 above.
35+
See [`test/README.md`](test/README.md) for the full test suite documentation — scripts, fixtures, what each validates, and how to run the pipeline locally.
7136
7237
<br>
7338

test/README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,33 @@ The `test/` directory contains a headless CI suite that runs inside the devconta
3232

3333
## Running locally
3434

35-
See [Running the CI pipeline locally](../README.md#running-the-ci-pipeline-locally) in the root README.
35+
The GitHub Actions workflow (`.github/workflows/validate.yml`) builds the devcontainer image and mounts the repo into it. You can reproduce this locally in two ways.
36+
37+
### Option 1 — Direct Docker (recommended for this config)
38+
39+
The most reliable local approach, since the workflow uses Docker-in-Docker internally:
40+
41+
```bash
42+
# Build the devcontainer image
43+
docker build -f .devcontainer/Dockerfile -t nvim-config:ci .
44+
45+
# Run the full validation suite
46+
docker run --rm \
47+
-e CI=true \
48+
-v "$(pwd):/home/dev/.config/nvim:ro" \
49+
nvim-config:ci \
50+
bash /home/dev/.config/nvim/test/ci_validate.sh
51+
```
52+
53+
The `-e CI=true` flag skips heavy binary downloads (LSP servers, DAP adapters) so the run completes in under 5 minutes.
54+
55+
### Option 2 — [act](https://github.com/nektos/act)
56+
57+
[act](https://github.com/nektos/act) runs GitHub Actions workflows locally using Docker. Install it via your package manager, then:
58+
59+
```bash
60+
# Run the validate job (mirrors what GitHub runs on push/PR)
61+
act push -j validate
62+
```
63+
64+
> **Note:** Because the workflow itself uses `docker/build-push-action`, `act` requires Docker-in-Docker. If the build step fails, fall back to Option 1 above.

0 commit comments

Comments
 (0)