This repository has been archived by the owner on Aug 13, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update all docs/tests to use the .factfile extension (closes #34)
Renamed .factotum files in samples .factfile (#34) Renamed .factotum files in tests to .factfile (#34) Renamed .factotum files to .factfile in README (#34)
- Loading branch information
Showing
14 changed files
with
20 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,28 +20,28 @@ unzip factotum_0.2.0_linux_x86_64.zip | |
./factotum --help | ||
``` | ||
|
||
Factotum requires one argument, which is a **[factotum factfile](/README.md#factfile-format)** that describes the job to run. For example, to run the sample **[sleep.factotum](https://raw.githubusercontent.com/snowplow/factotum/release/0.2.0/samples/sleep.factotum)**: | ||
Factotum requires one argument, which is a **[factotum factfile](/README.md#factfile-format)** that describes the job to run. For example, to run the sample **[sleep.factfile](https://raw.githubusercontent.com/snowplow/factotum/release/0.2.0/samples/sleep.factfile)**: | ||
|
||
```{bash} | ||
wget https://raw.githubusercontent.com/snowplow/factotum/release/0.2.0/samples/sleep.factotum | ||
./factotum sleep.factotum | ||
wget https://raw.githubusercontent.com/snowplow/factotum/release/0.2.0/samples/sleep.factfile | ||
./factotum sleep.factfile | ||
``` | ||
Specifying variables in the job file can be done using `--env JSON` (or `-e JSON`). The `JSON` here is free-form and needs to correspond to the placeholders you've set in your job. | ||
|
||
For example, the following will print "hello world!": | ||
|
||
```{bash} | ||
wget https://raw.githubusercontent.com/snowplow/factotum/release/0.2.0/samples/variables.factotum | ||
./factotum variables.factotum --env '{ "message": "hello world!" }' | ||
wget https://raw.githubusercontent.com/snowplow/factotum/release/0.2.0/samples/variables.factfile | ||
./factotum variables.factfile --env '{ "message": "hello world!" }' | ||
``` | ||
|
||
Starting from an arbitrary task can be done using the `--start TASK` or `-s TASK` arguments, where TASK is the name of the task you'd like to start at. | ||
|
||
For example, to start at the "echo beta" task in [this job](https://raw.githubusercontent.com/snowplow/factotum/release/0.2.0/samples/echo.factotum), you can run the following: | ||
For example, to start at the "echo beta" task in [this job](https://raw.githubusercontent.com/snowplow/factotum/release/0.2.0/samples/echo.factfile), you can run the following: | ||
|
||
```{bash} | ||
wget https://raw.githubusercontent.com/snowplow/factotum/release/0.2.0/samples/echo.factotum | ||
./factotum echo.factotum --start "echo beta" | ||
wget https://raw.githubusercontent.com/snowplow/factotum/release/0.2.0/samples/echo.factfile | ||
./factotum echo.factfile --start "echo beta" | ||
``` | ||
|
||
To get a quick overview of the options provided, you can use the `--help` or `-h` argument: | ||
|
@@ -118,15 +118,15 @@ Factotum is written in **[Rust](https://www.rust-lang.org/)**. | |
* Set up a Vagrant box and ssh into it - `vagrant up && vagrant ssh` | ||
* This will take a few minutes | ||
* `cd /vagrant` | ||
* Compile and run a demo - `cargo run -- samples/echo.factotum` | ||
* Compile and run a demo - `cargo run -- samples/echo.factfile` | ||
|
||
### Using stable Rust without Vagrant | ||
|
||
* **[Install Rust](https://www.rust-lang.org/downloads.html)** | ||
* on Linux/Mac - `curl -sSf https://static.rust-lang.org/rustup.sh | sh` | ||
* Clone this repository - `git clone [email protected]:snowplow/factotum.git` | ||
* `cd factotum` | ||
* Compile and run a demo - `cargo run -- samples/echo.factotum` | ||
* Compile and run a demo - `cargo run -- samples/echo.factfile` | ||
|
||
## Copyright and license | ||
|
||
|
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.