From fb60ba67f646288b40818a555bb716405e144956 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Fri, 13 Jan 2023 09:18:27 +0200 Subject: [PATCH] Announce just --- CHANGELOG.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index e01d69d6e..b66cc8ba7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,26 @@ +# 2023-01-13 + +## Support for running commands via just + +We've previously used [make](https://www.gnu.org/software/make/) for easily running some playbook commands (e.g. `make roles` which triggers `ansible-galaxy`, see [Makefile](Makefile)). +Our `Makefile` is still around and you can still run these commands. + +In addition, we've added support for running commands via [just](https://github.com/casey/just) - a more modern command-runner alternative to `make`. Instead of `make roles`, you can now run `just roles` to accomplish the same. + +Our [justfile](justfile) already defines some additional helpful **shortcut** commands that weren't part of our `Makefile`. Here are some examples: + +- `just install-all` to trigger the much longer `ansible-playbook -i inventory/hosts setup.yml --tags=install-all,ensure-matrix-users-created,start` command +- `just install-all --ask-vault-pass` - commands also support additional arguments (`--ask-vault-pass` will be appended to the above installation command) +- `just run-tags install-mautrix-slack,start` - to run specific playbook tags +- `just start-all` - (re-)starts all services +- `just stop-group postgres` - to stop only the Postgres service +- `just register-user john secret-password yes` - registers a `john` user with the `secret-password` password and admin access (admin = `yes`) + +Additional helpful commands and shortcuts may be defined in the future. + +This is all completely optional. If you find it difficult to [install `just`](https://github.com/casey/just#installation) or don't find any of this convenient, feel free to run all commands manually. + + # 2023-01-11 ## mautrix-slack support