Skip to content
This repository has been archived by the owner on Aug 13, 2024. It is now read-only.

Commit

Permalink
Prepared for release
Browse files Browse the repository at this point in the history
  • Loading branch information
ninjabear authored and alexanderdean committed Jun 13, 2016
1 parent a2b14a0 commit dd882d0
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 5 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
Version 0.2.0 (2016-06-13)
--------------------------
Allow terminal colour toggling using CLICOLOR (#51)
Improve output to STDERR / STDOUT (#51)
Support starting from an arbitrary task using --start option (#4)
Support variables in Factfiles, using mustache / --env option (#21)

Version 0.1.0 (2016-04-08)
--------------------------
Initial release
33 changes: 28 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Factotum

[![Build Status](https://travis-ci.org/snowplow/factotum.svg?branch=master)](https://travis-ci.org/snowplow/factotum) [![Release 0.1.0](http://img.shields.io/badge/release-0.1.0-blue.svg?style=flat)](https://github.com/snowplow/factotum/releases) [![Apache License 2.0](http://img.shields.io/badge/license-Apache--2-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0)
[![Build Status](https://travis-ci.org/snowplow/factotum.svg?branch=master)](https://travis-ci.org/snowplow/factotum) [![Release 0.2.0](http://img.shields.io/badge/release-0.2.0-blue.svg?style=flat)](https://github.com/snowplow/factotum/releases) [![Apache License 2.0](http://img.shields.io/badge/license-Apache--2-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0)

A dag running tool designed for efficiently running complex jobs with non-trivial dependency trees.

Expand All @@ -15,18 +15,41 @@ A dag running tool designed for efficiently running complex jobs with non-trivia
Assuming you're running **64 bit Linux**:

```{bash}
wget https://bintray.com/artifact/download/snowplow/snowplow-generic/factotum_0.1.0_linux_x86_64.zip
unzip factotum_0.1.0_linux_x86_64.zip
wget https://bintray.com/artifact/download/snowplow/snowplow-generic/factotum_0.2.0_linux_x86_64.zip
unzip factotum_0.2.0_linux_x86_64.zip
./factotum --help
```

Factotum currently accepts 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.1.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.factotum](https://raw.githubusercontent.com/snowplow/factotum/release/0.2.0/samples/sleep.factotum)**:

```{bash}
wget https://raw.githubusercontent.com/snowplow/factotum/release/0.1.0/samples/sleep.factotum
wget https://raw.githubusercontent.com/snowplow/factotum/release/0.2.0/samples/sleep.factotum
./factotum sleep.factotum
```
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!" }'
```

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:

```{bash}
wget https://raw.githubusercontent.com/snowplow/factotum/release/0.2.0/samples/echo.factotum
./factotum echo.factotum --start "echo beta"
```

To get a quick overview of the options provided, you can use the `--help` or `-h` argument:

```{bash}
./factotum --help
```

For more information on this file format and how to write your own jobs, see the **[Factfile format](/README.md#factfile-format)** section below.

## Factfile format
Expand Down

0 comments on commit dd882d0

Please sign in to comment.