Tup refactor - downstream changes (ci, docs)

ci/build/dev.sh: 
docs/a.md: 
docs/book/src/installation.md: 
docs/tests.md: 
justfile: 
nix/shells/armShell.nix: 
non-nix-build/env.sh: 
src/db-backend/editor-config/emacs/init.el: 
tup-build-staging-status.md: 
wdio.conf.js: 

Signed-off-by: Tzanko Matev <[email protected]>

Author: tzanko-matev

ci/build/dev.sh

@@ -15,11 +15,8 @@ echo '##########################################################################
 # stop processes: make sure none of those processes left from last build
 stop_processes
 
-git clean -xfd src/build-debug
-
-mv src/links links
-git clean -xfd src/
-mv links src/links
+git clean -fdx src/build
+git clean -fdx src/build-debug/build
 
 echo '###############################################################################'
 echo "Build:"
@@ -35,9 +32,12 @@ tup generate --config build-debug/tup.config "$TUP_OUTPUT_SCRIPT"
 ./"$TUP_OUTPUT_SCRIPT"
 rm "$TUP_OUTPUT_SCRIPT"
 
-# TODO: this is not really working, problems with variants: generated script produce
-#   files directly in src/, instead of in src/build-debug, and so it can't run well
-#   we need to see if we can generate it in a better way, or to wrap/restructure the resulting folders
-#   to make possible to test the dev build in CI
+# Running the generated script populates the staging tree; clean it so that
+# subsequent `tup` invocations (locally or in CI) can start from a fresh slate.
+git clean -fx .
+
+popd
 
+pushd src/build-debug
+git clean -fx .
 popd

docs/a.md

@@ -8,7 +8,7 @@
 ### Local
 
 I sometimes do 
-`set -gx PATH /home/al/codetracer/src/build-debug $PATH`
+`set -gx PATH /home/al/codetracer/src/build-debug/build $PATH`
 to get many codetracer-related binaries in my path: `codetracer`, `tester` and maybe others
 
 # Fix preloading
@@ -83,4 +83,3 @@ to get many codetracer-related binaries in my path: `codetracer`, `tester` and m
 
 
 
-

docs/book/src/installation.md

@@ -62,9 +62,12 @@ Direnv should be set up in your shell, as shown [here](https://direnv.net/docs/h
    ```
 4. Run `nix develop`
 5. Run `direnv allow`
-6. To build codetracer simply run `just build`. The location of the resulting binary will be `./src/build-debug/bin/ct`
+6. To build codetracer simply run `just build`. The location of the resulting binary will be `./src/build-debug/build/bin/ct`
 7. Now every time you enter the `codetracer` directory your environment should be updated
 
+> [!NOTE]
+> When you need to use `tup generate`, remember that the generated script writes into the staging tree. After it finishes, run `cd src/build && git clean -fx .` followed by `cd ../build-debug && git clean -fx .` before invoking `tup` again.
+
 > [!TIP]
 > Users of Visual Studio Code might encounter issues when using `code .`. To fix them do the following:
 > 1. Run `direnv deny`

docs/tests.md

@@ -21,6 +21,6 @@ we can save the steps in a file by passing `--file`, instead of running those au
 Running:
 
 ```bash
-src/build-debug/tests/run/a_test <traceID>
-src/build-debug/tests/run/a_test examples/sum.nim
+src/build-debug/build/tests/run/a_test <traceID>
+src/build-debug/build/tests/run/a_test examples/sum.nim
 ```

justfile

@@ -14,10 +14,10 @@ build:
   # build-debug/codetracer user-setup
 
   # Start building continuously
-  cd src
+  cd src/build
   tup build-debug
   tup monitor -a
-  cd ../
+  cd ../..
 
   # start webpack
   node_modules/.bin/webpack --watch --progress & # building frontend_bundle.js
@@ -34,17 +34,18 @@ build-once:
   # problem because the Tupfiles refer to it.
   mkdir public/dist
 
-  cd src
+  cd src/build
   tup build-debug
-  cd ..
+  cd ../..
 
   # Build frontend_bundle.js in the dist folder
   node_modules/.bin/webpack --progress
 
   # We need to execute another tup run because webpack may have created some new files
   # that tup will discover
-  cd src
+  cd src/build
   tup build-debug
+  cd ../..
 
 build-docs:
   #!/usr/bin/env bash
@@ -103,7 +104,7 @@ build-macos-app:
 build-app-image:
   ./appimage-scripts/build_appimage.sh
 
-tester := "src/build-debug/bin/tester"
+tester := "src/build-debug/build/bin/tester"
 
 test-ui headless="0":
   #!/usr/bin/env bash
@@ -215,7 +216,7 @@ pid pid_or_current_or_last:
   #!/usr/bin/env bash
   # argument can be either `current`, `last` or a pid number
   if [[ "{{pid_or_current_or_last}}" == "current" ]]; then \
-    echo $(ps aux | grep src/build-debug/codetracer | head -n 1 | awk '{print $2}') ; \
+    echo $(ps aux | grep src/build-debug/build | head -n 1 | awk '{print $2}') ; \
   elif [[ "{{pid_or_current_or_last}}" == "last" ]]; then \
     TTMP=$(just findtmp) ; \
     echo $(cat $TTMP/last-start-pid) ; \

nix/shells/armShell.nix

@@ -197,7 +197,7 @@ mkShell {
 
     # ====
 
-    export CODETRACER_LINKS_PATH=$PWD/src/build-debug/
+    export CODETRACER_LINKS_PATH=$PWD/src/build-debug/build
 
     echo "{\"PYTHONPATH\": \"$CT_PYTHONPATH\",\"LD_LIBRARY_PATH\":\"$CT_LD_LIBRARY_PATH\"}" > ct_paths.json
 
@@ -244,10 +244,10 @@ mkShell {
     rm -rf $ROOT_PATH/node_modules
     ln -s $NIX_NODE_PATH $ROOT_PATH/node_modules
 
-    export NIX_CODETRACER_EXE_DIR=$ROOT_PATH/src/build-debug/
-    export LINKS_PATH_DIR=$ROOT_PATH/src/build-debug/
+    export NIX_CODETRACER_EXE_DIR=$ROOT_PATH/src/build-debug/build
+    export LINKS_PATH_DIR=$ROOT_PATH/src/build-debug/build
     export CODETRACER_REPO_ROOT_PATH=$ROOT_PATH
-    export PATH=$PATH:$PWD/src/build-debug/bin
+    export PATH=$PWD/src/build/bin:$PWD/src/build-debug/build/bin:$PATH
     export PATH=$PATH:$ROOT_PATH/node_modules/.bin/
     export CODETRACER_DEV_TOOLS=1
     export CODETRACER_LOG_LEVEL=INFO

non-nix-build/env.sh

@@ -49,7 +49,7 @@ if [ ! -f "$ROOT_DIR"/ct_paths.json ]; then
   echo "{\"PYTHONPATH\": \"\",\"LD_LIBRARY_PATH\":\"\"}" > "$ROOT_DIR"/ct_paths.json
 fi
 
-export PATH=$DEPS_DIR/nim/bin:$ROOT_DIR/node_modules/.bin:$BIN_DIR:$CARGO_HOME/bin:$ROOT_DIR/src/build-debug/bin:$PATH
+export PATH=$DEPS_DIR/nim/bin:$ROOT_DIR/node_modules/.bin:$BIN_DIR:$CARGO_HOME/bin:$ROOT_DIR/src/build/bin:$ROOT_DIR/src/build-debug/build/bin:$PATH
 
 if [ "$os" == "mac" ]; then
   brew install sqlite3 ruby node universal-ctags go capnp

src/db-backend/editor-config/emacs/init.el

@@ -30,7 +30,7 @@
 (dap-register-debug-provider
  "rust"
  (lambda (conf)
-   (plist-put conf :dap-server-path "/home/alexander92/codetracer/src/build-debug/bin/db-backend")
+   (plist-put conf :dap-server-path "/home/alexander92/codetracer/src/build-debug/build/bin/db-backend")
    conf))
 
 (dap-register-debug-template "CodeTracer db-backend rust"
@@ -40,4 +40,4 @@
                                    :traceFolder "/home/alexander92/.local/share/codetracer/trace-414/"
                                    :name "CodeTracer db-backend rust"))
 
-(toggle-debug-on-error)
+(toggle-debug-on-error)

tup-build-staging-status.md

@@ -4,12 +4,11 @@
 - Relocated the entire Tup graph to `src/build/`, with `Tupfile.ini` still rooted in `src/`; `tup` now runs directly from the staging tree and no `src/Tupfile` shim is needed.
 - Standardized on per-file `SRC_DIR` handling for relocated Tupfiles, added `!cp_preserve` plus `src/build/.gitignore`, and refreshed `.agents/codebase-insights.txt`; no further Tupfile edits are planned.
 - Validated the build: both `tup` and `tup generate` succeed, `just build` / `just build-once` work end-to-end, and their outputs land under `src/build/` or `src/build-debug/build/` as intended.
+- Aligned developer tooling (Just recipes, CI helpers, Nix shells, non-Nix env scripts) and documentation—including contributor guides, mdBook outputs, and WebDriver specs—with the `src/build/` staging root and the new `build-debug/build` artifact paths, and documented the required clean-up after running generated scripts.
 
 ## In Progress
-- Update tooling, scripts, and documentation (CI jobs, `justfile`, Nix shells, onboarding guides) to reference `src/build-debug/build/**` and reflect the new staging entry point.
-- Capture the operational caveat that a generated script populates `src/build/`; developers must run `cd src/build && git clean -fx .` followed by `cd ../build-debug && git clean -fx .` before returning to live `tup` runs.
+- Monitor developer tooling and CI jobs for regressions now that their scripts target `src/build/` and `src/build-debug/build/**`; collect feedback from early adopters before marking ADR 0006 as accepted.
 
 ## Next
-- Sweep remaining references to `src/build-debug/bin` (arm shell, docs, helper scripts) and switch them to `src/build-debug/build/**`.
-- Document the post-`tup.sh` clean-up sequence across contributor docs and CI scripts, adding automation where possible to enforce a clean staging area.
 - Verify CI and developer tooling run successfully with the updated paths and documented clean-up, then mark ADR 0006 as accepted.
+- Capture any follow-up automation needed to enforce the post-`tup.sh` cleaning workflow (e.g., pre-commit hooks or CI guardrails) based on user feedback.

wdio.conf.js

@@ -14,10 +14,10 @@ const config = {
     [
       'electron',
       {
-        // appPath: 'node_modules/.bin/', // join(__dirname, 'src/build-debug/dist'),
+        // appPath: 'node_modules/.bin/', // join(__dirname, 'src/build-debug/build/dist'),
         // appName: 'electron',
         binaryPath: join(__dirname, 'node_modules', '.bin', 'electron'),
-        appArgs: ['app=src/build-debug'],
+        appArgs: ['app=src/build-debug/build'],
         chromedriver: {
           port: 9519,
           logFileName: 'wdio-chromedriver.log',
@@ -36,7 +36,7 @@ const config = {
   logLevel: 'debug',
   runner: 'local',
   outputDir: 'wdio-logs',
-  specs: ['./src/build-debug/tests/dom_test.js'],
+  specs: ['./src/build-debug/build/tests/dom_test.js'],
 
   // framework: 'mocha',
   // mochaOpts: {