Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ You immediately see **WHAT** can be done in this repo and **HOW** it can be done
Now, running build is as simple as:
```
> ./runo build
Buld is running
Build is running
done
```

Expand All @@ -48,14 +48,14 @@ But what if you want to perform build/tests/... for different platforms?
Not a problem, just ask `runo` to show all available containers and run
command in any of them as easy as that:
```
> ./runo --containers
> ./runo -c
Following containers are available:
* Debian
* Centos
* RockyLinux

> ./runo -c Debian build
Buld for Debian is running
Build for Debian is running
done
```

Expand Down
11 changes: 6 additions & 5 deletions docs/CONFIG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `runo` Config File Reference

## Table of content
## Table of contents
- [Introduction](#introduction)
- [Commands](#commands)
- - [Mandatory fields](#mandatory-fields)
Expand Down Expand Up @@ -32,7 +32,7 @@ Therefore, `runo` config contains 2 lists of objects:

## Commands

Configuration of every command consists of several simple fields.
Configuration of every command consists of several simple fields.
First, few examples, and then we will discuss details.
- Simplest case: command config uses only mandatory fields:
```toml
Expand All @@ -46,7 +46,7 @@ execute = "python3 -m tests.e2e.run"
[[commands]]
name = "test"
description = "runs unit tests"
before = ["echo This is just an exampe", "echo You should configure your tests here"]
before = ["echo This is just an example", "echo You should configure your tests here"]
execute = "pytest"
after =["echo done > /dev/null"]
examples = ["tests --cov -vv", "tests --last-failed"]
Expand Down Expand Up @@ -114,13 +114,14 @@ the main part. Example:
Similar to `before`, but executed after the main part. Example:
- `["rm -f /tmp/unneeded_files*"]`

Please note that these command are executed on host machine (not inside container).
Please note that these commands are executed on host machine (not inside container).

#### `docker_container` (`string`)

Name of the container (defined in the same config), which should be used
by the command by default. It can be overwritten via CLI at moment of run
with help of `-c`/`--container` option.
with help of `-c`/`--container` option. You can also use `-c` without a value
to list all available containers configured in the config file.

#### `docker_run_options` (`string`)

Expand Down
6 changes: 3 additions & 3 deletions docs/QUICK_START.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ on any development machine by default nowadays:

Go to root of your repository and do one of two things:
<details>
<summary>Just copy file directly to you repo (and make it executable)</summary>
<summary>Just copy file directly to your repo (and make it executable)</summary>

```
wget https://raw.githubusercontent.com/frwl404/runo/refs/heads/master/runo &&\
Expand Down Expand Up @@ -63,9 +63,9 @@ Following commands are available:
* pre-commit - quick checks/fixes of code formatting (ruff/mypy) ['./runo pre-commit']
* update-deps - updates dependencies, used in project, to the latest versions ['./runo update-deps']
```
At this moment most part of them are just a mocks, which prints something to console,
At this moment most of them are just mocks, which print something to console,
because at this moment `./runo` doesn't know what `test`/`build`/`...` means for your project.
Only `./runo shell` do exactly what you expect from it (because it is quite universal thing, which means the same in any repo/project).
Only `./runo shell` does exactly what you expect from it (because it is quite universal thing, which means the same in any repo/project).

## 3. Adopt generated config for your needs.

Expand Down
Loading