https://github.com/kostya-zero/tesuto
✅ Lightweight automation tool.
https://github.com/kostya-zero/tesuto
testing
Last synced: about 1 year ago
JSON representation
✅ Lightweight automation tool.
- Host: GitHub
- URL: https://github.com/kostya-zero/tesuto
- Owner: kostya-zero
- License: mit
- Created: 2023-08-08T04:49:19.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-05T05:59:13.000Z (over 1 year ago)
- Last Synced: 2025-04-06T15:03:51.855Z (about 1 year ago)
- Topics: testing
- Language: Rust
- Homepage:
- Size: 226 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Tesuto
Tesuto is a minimalist tool that allows you to automate things like builds, deploys etc. It uses YAML syntax for their project files to be less harder to understand how to work with it.
The main goal of this project is to provide a utility that is fast, lightweight and easy-to-use.
## Installation
You can install Tesuto with `cargo`:
```shell
cargo install tesuto
```
Also, if you have `cargo-binstall` installed, you can use it too:
```shell
cargo binstall tesuto
```
## Usage
To generate an example project, you can use `generate` command:
```shell
tesuto generate
```
> Refer to [configuration](#configuration) section for how to configure project.
You can run your project with ease by using `run` command:
```shell
tesuto run
# If your project is in different location.
tesuto run --project "configs/tesuto.yml"
```
Also, you can run specific job with `--job` flag:
```shell
tesuto run --job cargo
```
## Configuration
### Structure
Tesuto uses YAML syntax for projects. The structure for project is pretty simple:
```yaml
name: TesutoProject
jobs:
hello:
- name: Print 'Hello world!'
run: echo "Hello World!"
quiet: false
```
In the code block above you can see an example project. If you choose to not generate example project, you will see an empty one like this:
```yaml
name: TesutoProject
require: []
jobs: {}
```
In the root of project there is 3 fields:
- `name` - Used to identify project.
- `with` - Additional options to run your project.
- `require` - List of programs that required to run this project.
- `jobs` - Actions that Tesuto need to do.
We will skip `name` field because it's obvious what it is purpose.
### `with` option
The `with` field serves as additional options for your project. It has 2 options:
```yaml
...
with:
shell:
program: "zsh"
args:
- "-c"
- "{}"
cwd: "build"
```
- `shell` - Allows you to specify the shell you want to run. Note that it is important to add curly braces to the args field as in the example above, because Tesuto will replace them with a command to run.
- `cwd` - Changes the working directory for Tesuto.
### Required Programs
In the `require` field you can specify which programs are required to run this project:
```yaml
...
require:
- git
- cargo
...
```
It's a list of program that will be found through search in PATH. If one of this programs are not found, Tesuto will crash and tell you which program is not found.
### Jobs and Steps
Jobs contain steps that Tesuto needs to perform to complete a job. Every job in a project will be executed step-by-step. The syntax of a job looks like this:
```yaml
...
jobs:
cargo:
- name: Build release binary
run: cargo build --release
quiete: false
...
```
Step has 3 properties:
- `name` - The name of the step. If it's empty, it will be replaced with the command that the step should run.
- `run` - The command to run. If this field is empty, Tesuto will display only the name of the step. If both name and run fields are empty, Tesuto will skip the step.
- `quiet` - Whether to display the output or not.
You can create as many jobs and steps as needed. There are no limits for your workflow.