|
1 | 1 | # deployer |
2 | 2 |
|
3 | | -Deployer is a relative simple, yet powerful localhost CI/CD instrument. It allows you to: |
| 3 | +Deployer is a relatively simple, yet powerful localhost CI/CD instrument. It allows you to: |
4 | 4 |
|
5 | 5 | - have your own actions and pipelines repositories (`Actions Registry` and `Pipelines Registry`) in a single JSON file |
6 | 6 | - create actions and pipelines from TUI or using JSON/YAML/TOML configuration files |
7 | 7 | - configure actions for specific project |
8 | 8 | - satisfy requirements for your system to run pipelines |
9 | 9 | - check compatibility over actions and projects |
10 | | -- run actions and pipelines at remote hosts (you need to setup your remote with SSH key and install `deployer`) |
| 10 | +- run actions and pipelines on remote hosts (you need to setup your remote access using SSH key, also you need to install `deployer` on remote host) |
11 | 11 | - use variables for commands from `env`-files and HashiCorp Vault KV2-storage |
12 | 12 | - run pipelines with different cache requirements in different build folders |
13 | | -- run pipelines inside containered environments (Docker by default) with cache strategies |
| 13 | +- run pipelines inside containerized environments (Docker by default) with cache strategies |
14 | 14 | - store common content in Deployer's storage, add and patch additional files for build on the fly |
15 | 15 | - and share your project build/deploy settings very quickly and without any dependencies. |
16 | 16 |
|
@@ -43,7 +43,7 @@ That's it! Now you have `/home/username/.cargo/bin/deployer` binary. Modify the |
43 | 43 |
|
44 | 44 | ## Usage |
45 | 45 |
|
46 | | -All project configuration store in `deploy-config.json` or `.deploy-config.json` file. |
| 46 | +All project configuration is stored in `deploy-config.json` or `.deploy-config.json` file. |
47 | 47 |
|
48 | 48 | First of all, let's create a simple action. |
49 | 49 |
|
@@ -92,7 +92,7 @@ The full JSON is: |
92 | 92 | } |
93 | 93 | ``` |
94 | 94 |
|
95 | | -If you're interesting in UPX, consider to visit it [home page](https://upx.github.io/). |
| 95 | +If you're not familiar with UPX, consider visiting it's [home page](https://upx.github.io/). |
96 | 96 |
|
97 | 97 | So, let's create a pipeline that will build the binary from the Rust code with preinstalled `cargo-rel@0.1` action and then compress this binary with `upx-compress@0.1.0`. |
98 | 98 |
|
@@ -233,7 +233,7 @@ deployer init |
233 | 233 | deployer with rust-default@0.1.0 |
234 | 234 | ``` |
235 | 235 |
|
236 | | -Deployer will consider you to specify some things (e.g., targets - for this project and `rust-default@0.1.0` Pipeline it will be `target/release/deployer`). After all you will get this `deploy-config.json`: |
| 236 | +Deployer will ask you to specify some things (e.g., targets - for this project and `rust-default@0.1.0` Pipeline it will be `target/release/deployer`). After all you will get this `deploy-config.json`: |
237 | 237 |
|
238 | 238 | ```json |
239 | 239 | { |
|
0 commit comments