Skip to content

Commit 01193d7

Browse files
committed
docs(ci): clarifier la règle temporaire vs persistée pour l'entrypoint
1 parent 60a336b commit 01193d7

3 files changed

Lines changed: 15 additions & 0 deletions

File tree

docs/ci_cd_ark_cli.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ Use this document as the single source of truth for ARK CI/CD behavior and examp
88
When pipeline behavior changes (flags, exit codes, fail-fast rules, JSON contracts),
99
update this page first and keep other references aligned to it.
1010

11+
Scope boundary:
12+
13+
- CI/CD persistence must be explicit through CLI commands (for example `workspace entrypoint-set`).
14+
- GUI temporary selections are not a CI contract and must not be treated as persisted workspace state.
15+
1116
## Goal
1217

1318
Automate the following steps for a workspace:
@@ -89,6 +94,12 @@ $ARK_BIN workspace entrypoint-set "$WORKSPACE_DIR" src/main.py --json
8994
$ARK_BIN workspace entrypoint-clear "$WORKSPACE_DIR" --json
9095
```
9196

97+
Important:
98+
99+
- In Engines standalone GUI, selecting a file is a temporary build/session choice.
100+
- It can read `ARK_Main_Config.yml`, but it does not write entrypoint changes back to config files.
101+
- For reproducible CI, persist entrypoint only with `workspace entrypoint-set`.
102+
92103
## Command Breakdown
93104

94105
- `workspace apply --with-venv --strict`

docs/contributing.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ Release-oriented checks should follow the CLI examples in this guide and the REA
7878
- If you change the command hierarchy (`gui`, `engine`, `workspace`, `init`, `config-auto`, `check`, `scaffold`) or JSON outputs, update the CLI docs.
7979
- Keep CI-facing exit codes stable, or document the change explicitly in the README.
8080
- For CI/CD behavior, keep [`docs/ci_cd_ark_cli.md`](./ci_cd_ark_cli.md) as the single source of truth and align other docs/examples to it.
81+
- For GUI behavior that impacts CI expectations (entrypoint, workspace persistence, engine config), explicitly state whether behavior is temporary session state or persisted workspace state.
8182
- If you change IDE/classic behavior, update the IDE docs when appropriate.
8283

8384
## Documentation expectations

docs/dedicated_cli.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,4 +104,7 @@ ark-cli> exit
104104
- When a GUI command is executed (`main`, `bcasl`, `engines`), control returns to the prompt after the GUI is closed.
105105
- If Rich is installed, output is colorized. If not, the CLI still works in plain mode.
106106
- `engine compile` validates the target file path before running the engine command.
107+
- In Engines standalone GUI, file selection is temporary for the current build/session.
108+
- Engines standalone GUI may read workspace config (`ARK_Main_Config.yml`) but does not persist entrypoint changes.
109+
- To persist entrypoint in workspace config, use `workspace entrypoint-set`.
107110
- For automation, prefer the top-level commands documented in the README (`engine`, `workspace`, `doctor`, `scaffold`, `gui`).

0 commit comments

Comments
 (0)