Skip to content

Commit b583588

Browse files
committed
docs(CHANGES): Note tmuxinator/teamocil import behavior changes
why: Phase 1 of the tmuxinator-parity branch (PR #1014) is behavior- changing for users importing tmuxinator/teamocil configs. Document what changed so upgraders know what to expect. what: Adds a "Behavior changes — tmuxinator/teamocil import" section to the upcoming-release placeholder, summarizing all 7 import-side fixes and the v1.x teamocil format support. Also drops a stray blank line in tests/workspace/test_import_teamocil.py left by an autosquash conflict resolution (cosmetic, ruff-format).
1 parent f8472c8 commit b583588

2 files changed

Lines changed: 28 additions & 1 deletion

File tree

CHANGES

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,34 @@ $ pipx install \
3939
_Notes on the upcoming release will go here._
4040
<!-- END PLACEHOLDER - ADD NEW CHANGELOG ENTRIES BELOW THIS LINE -->
4141

42+
### Behavior changes — tmuxinator/teamocil import (#1014)
43+
44+
- **tmuxinator**: `pre` now correctly maps to `before_script` (was: per-pane
45+
`shell_command_before`). Importer warns when `pre` contains shell
46+
constructs like pipes/redirects since `before_script` runs without
47+
`shell=True`. Combo `pre` + `pre_window` previously dropped `pre`
48+
entirely; both keys now map independently.
49+
- **tmuxinator**: `cli_args`/`tmux_options` now use `shlex` parsing.
50+
`-L` (socket name) and `-S` (socket path) are extracted (were silently
51+
dropped). Paths containing `-f` no longer corrupt the config value.
52+
Unknown flags and missing-value flags warn.
53+
- **tmuxinator**: new key translations — `rvm`, `pre_tab`,
54+
`startup_window`, `startup_pane`, `on_project_first_start`,
55+
`socket_path`. `attach: false` warns and directs to `tmuxp load -d`.
56+
`startup_window`/`startup_pane` resolve by name OR integer index to
57+
set `focus: true` on the matching window/pane.
58+
- **teamocil**: v1.x format now supported. Importer auto-dispatches to
59+
v0.x or v1.x based on `session:` wrapper, `splits`/`filters`/`cmd`
60+
markers. v1.x handles bare-string panes, `commands`, per-window/pane
61+
`focus`, window `options`. v1.x pane dicts with no recognizable keys
62+
produce empty panes and warn.
63+
- **teamocil**: v0.x configs now emit `environment: {TEAMOCIL: "1"}` by
64+
default (matches `with_env_var: true` from teamocil 0.4-stable).
65+
Suppress with `with_env_var: false` (also accepts the YAML-quoted
66+
string `"false"`).
67+
- **teamocil**: v0.x pane `width`/`height`/`target` keys now drop with a
68+
WARNING (were silently dropped or passed through as dead data).
69+
4270
### Documentation
4371

4472
- Visual improvements to API docs from [gp-sphinx](https://gp-sphinx.git-pull.com)-based Sphinx packages (#1035)

tests/workspace/test_import_teamocil.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,6 @@ def test_import_teamocil_v1x_unknown_pane_keys_warns(
272272
assert getattr(warnings[0], "tmux_key", None) == "width"
273273

274274

275-
276275
def test_import_teamocil_warns_on_v0x_pane_geometry(
277276
caplog: pytest.LogCaptureFixture,
278277
) -> None:

0 commit comments

Comments
 (0)