1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
|
# Migration notes
Migration and deprecation notes for tmuxp are here, see {ref}`changelog` as
well.
```{admonition} Welcome on board! 👋
1. 📌 For safety, **always** pin the package
2. 📖 Check the migration notes _(You are here)_
3. 📣 If you feel something got deprecated and it interrupted you - past, present, or future - voice your opinion on the [tracker].
We want to make tmuxp fun, reliable, and useful for users.
API changes can be painful.
If we can do something to draw the sting, we'll do it. We're taking a balanced approach. That's why these notes are here!
(Please pin the package. 🙏)
[tracker]: https://github.com/tmux-python/tmuxp/discussions
```
## Next release
_Notes on the upcoming release will be added here_
<!-- Maintainers, insert changes / features for the next release here -->
## tmuxp 1.18.0 (2022-10-30)
**Restructuring** (#840)
"Config files" and "configs" are now referred to as workspace files.
Additionally, there's been a major file structure update:
- `cli/utils.py` functions moved to `workspace/finders.py`
- `config.py` split between:
- `workspace/finders.py`
- `workspace/freezer.py`
- `workspace/importers.py`
- `workspace/validation.py`
- `workspacebuilder.py` split into:
- `workspace/builder.py`
- `workspace/freezer.py`
`config.inline` moved to freezer
Tests:
- `tests/fixtures/{workspacebuilder,workspacefreezer}` -> `tests/fixtures/workspace/{builder,freezer}`
- `tests/test_import_{teamocil,tmuxinator}.py` -> `tests/workspace/test_import_{teamocil,tmuxinator}.py`
## tmuxp 1.17.0 (2022-10-09)
**Completions have changed** (#830)
Completions now use a different tool: [shtab]. See the [completions page] for more information.
If you were using earlier versions of tmuxp (earlier than 1.17.0), you may need to uninstall the old completions, first.
[completions page]: https://tmuxp.git-pull.com/cli/completion.html
[shtab]: https://docs.iterative.ai/shtab/
<!---
# vim: set filetype=markdown:
-->
|