Skip to content

Commit 078af65

Browse files
Docs/CI: update references to renamed Makefile targets
1 parent 8cae4f1 commit 078af65

13 files changed

Lines changed: 19 additions & 17 deletions

File tree

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Tick the rows that apply to this PR.
2525

2626
**Studio (Python / JS / CSS under `studio/`)**
2727

28-
- [ ] `make studio-test` passes locally (chains `ruff check` and runs the unit + Playwright e2e suite under `studio/tests/`)
28+
- [ ] `make test-studio` passes locally (chains `ruff check` and runs the unit + Playwright e2e suite under `studio/tests/`)
2929
- [ ] New tests for the changed behaviour live in `studio/tests/` (pytest unit) or `studio/tests/e2e/` (Playwright smoke)
3030

3131
**Documentation (`doc/`, applies to both components)**

.github/workflows/build_and_test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ jobs:
7878
- uses: ./.github/actions/install-knowledge-compilers
7979
- run: make -j$(nproc) && make tdkc && make provsql_migrate_mmap && make install
8080
- name: KCMCP protocol conformance (tdkc)
81-
run: make kcmcp-tdkc-test
81+
run: make test-kcmcp
8282
- run: echo "shared_preload_libraries = 'provsql'" >> /etc/postgresql/${{ matrix.pg }}/test/postgresql.conf
8383
- run: service postgresql restart
8484
- run: pg_isready -t 30

.github/workflows/macos.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ jobs:
7575
fetch-depth: 0
7676
- run: make -j$(sysctl -n hw.ncpu) && make tdkc && make provsql_migrate_mmap && make install
7777
- name: KCMCP protocol conformance (tdkc)
78-
run: make kcmcp-tdkc-test
78+
run: make test-kcmcp
7979
# pg_isready does a single connection attempt; the -t flag is the
8080
# connection timeout, not a retry duration. When the cluster is
8181
# mid-startup or in recovery, pg_isready returns 1 immediately.

.github/workflows/wasm.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ name: in-process store smoke
99
#
1010
# The full browser/PGlite build (a matched pglite.wasm + provsql.so), its
1111
# headless Node smoke test, and the Playwright browser e2e are reproduced
12-
# locally with `make wasm` / `make playground-test` (wasm/build-wasm.sh) rather
12+
# locally with `make wasm` / `make test-playground` (wasm/build-wasm.sh) rather
1313
# than in CI: that build is heavy, was only ever opt-in (never auto-triggered),
1414
# and the local script is the single source of truth.
1515

.github/workflows/wsl.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ jobs:
7979
fetch-depth: 0
8080
- run: make -j$(nproc) && make tdkc && make provsql_migrate_mmap && make install
8181
- name: KCMCP protocol conformance (tdkc)
82-
run: make kcmcp-tdkc-test
82+
run: make test-kcmcp
8383
- run: echo "shared_preload_libraries = 'provsql'" >> /etc/postgresql/*/*/postgresql.conf
8484
- run: service postgresql restart
8585
- run: perl -i -pe 's/\r//g unless /\\set ECHO none/' test/expected/*.out

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,10 @@ studio/.venv/bin/playwright install --with-deps chromium
8888

8989
# Run lint + the unit suite + the Playwright e2e smoke (against the
9090
# extension already installed on your local PostgreSQL).
91-
make studio-test
91+
make test-studio
9292
```
9393

94-
`make studio-test` chains `ruff check .` before `pytest tests`, so
94+
`make test-studio` chains `ruff check .` before `pytest tests`, so
9595
the same lint that gates CI also gates the local target. The
9696
release pipeline is documented in the [build-system
9797
chapter](https://provsql.org/docs/dev/build-system.html#studio-releases).
@@ -142,7 +142,7 @@ checker can validate them.
142142
Playwright smoke under `studio/tests/e2e/` that exercises
143143
the changed behaviour.
144144
3. Ensure the relevant local test target passes: `make test` for
145-
extension changes, `make studio-test` for Studio changes (or
145+
extension changes, `make test-studio` for Studio changes (or
146146
both if the change crosses the boundary).
147147
4. If your change touches the documentation, run `make docs` and
148148
confirm the coherence checker (`check-doc-links.py`) reports

doc/source/dev/build-system.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ ProvSQL uses two Makefiles:
1212

1313
- ``Makefile`` (top-level) -- user-facing targets: ``make``,
1414
``make test``, ``make docs``, ``make website``, ``make deploy``.
15-
This file delegates to ``Makefile.internal`` for the actual build.
15+
``make help`` prints the full grouped target menu. This file
16+
delegates to ``Makefile.internal`` for the actual build (a mistyped
17+
target is forwarded there and errors, rather than in the wrapper).
1618

1719
- ``Makefile.internal`` -- the real build file, based on
1820
PostgreSQL's **PGXS** (PostgreSQL Extension Building Infrastructure).

doc/source/dev/kc-server-protocol.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ any server that exists today.
3737
the protocol; ProvSQL itself keeps tree decomposition in process rather
3838
than talking to it over a socket. ``test/kcmcp/conformance.py`` drives it
3939
through a handshake, ``compile``/``wmc`` requests, ``PING``/``PONG``, and
40-
error cases (``make kcmcp-tdkc-test``).
40+
error cases (``make test-kcmcp``).
4141

4242

4343
Design goals

doc/source/dev/playground.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -180,13 +180,13 @@ Build, test, deploy
180180
artifacts from ``wasm/``: the matched PGlite dist and
181181
``provsql.tar.gz``). ``make playground`` reuses the in-place artifacts;
182182
``make wasm`` and the first build pass ``--pglite``/``--provsql``.
183-
* **Test**: ``make playground-test`` runs ``studio/tests/web/``, a
183+
* **Test**: ``make test-playground`` runs ``studio/tests/web/``, a
184184
headless-Chromium Playwright suite (JSPI is on by default in current
185185
Chromium) driving the real frontend + Python backend against the in-page
186186
PGlite. It covers boot, the query → circuit → semiring path, the ``/api``
187187
surface, database switching, Reset, deep links, sub-path portability, and
188188
a fully off-line boot. The browser build and this e2e run locally only (via
189-
``make wasm`` / ``make playground-test``), not in CI; the per-PR
189+
``make wasm`` / ``make test-playground``), not in CI; the per-PR
190190
``.github/workflows/wasm.yml`` job covers just the cheaper in-process-store
191191
single-session smoke.
192192
* **Deploy** with ``make deploy-playground`` (rsync to

doc/source/dev/studio.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ not override the ``--search-path provsql_test`` we pass at
408408
startup) and drives the live UI through a ``chromium`` instance.
409409

410410
Both suites live under the same ``pytest`` invocation: ``make
411-
studio-test`` from the repo root runs ``ruff check`` first, then
411+
test-studio`` from the repo root runs ``ruff check`` first, then
412412
``pytest tests`` (which walks both directories). For
413413
finer-grained runs, ``pytest tests --ignore=tests/e2e`` skips the
414414
chromium tax.

0 commit comments

Comments
 (0)