project 0.9.0 → 0.9.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/VERSION +1 -1
- data/lib/project/runner.rb +0 -1
- data/project.gemspec +1 -1
- data/readme.rdoc +21 -3
- metadata +2 -2
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
0.9.
|
|
1
|
+
0.9.2
|
data/lib/project/runner.rb
CHANGED
data/project.gemspec
CHANGED
data/readme.rdoc
CHANGED
|
@@ -7,10 +7,13 @@
|
|
|
7
7
|
* Note on Patches/Pull Requests
|
|
8
8
|
|
|
9
9
|
|
|
10
|
+
|
|
10
11
|
== Overview
|
|
11
12
|
|
|
12
13
|
Project aims to make working with multiple projects as simple as possible. By registering projects with workflows you can quickly create a set of commands that will be run against each project.
|
|
13
14
|
|
|
15
|
+
|
|
16
|
+
|
|
14
17
|
== Installation
|
|
15
18
|
|
|
16
19
|
The project is hosted on rubygems.org. Getting it is simple:
|
|
@@ -23,13 +26,17 @@ Once the gem is installed run:
|
|
|
23
26
|
|
|
24
27
|
Assuming you haven't already had the gem installed this will create a file at ~/.project. This is the main configuration file used to drive project.
|
|
25
28
|
|
|
29
|
+
|
|
30
|
+
|
|
26
31
|
== Usage
|
|
27
32
|
|
|
28
33
|
Project uses a YAML file for its configuration. Edit the file located in at ~/.project to you liking.
|
|
29
34
|
|
|
35
|
+
|
|
36
|
+
|
|
30
37
|
=== Projects
|
|
31
38
|
|
|
32
|
-
A project can be anything revolving around a particular context. A typical use would be opening your default environment surrounding a project. An example project configuration might look like this:
|
|
39
|
+
A project can be anything revolving around a particular context. A typical use case would be opening your default environment surrounding a particular project. An example project configuration might look like this:
|
|
33
40
|
|
|
34
41
|
:name:
|
|
35
42
|
:path: /path/to/project
|
|
@@ -37,14 +44,25 @@ A project can be anything revolving around a particular context. A typical use w
|
|
|
37
44
|
|
|
38
45
|
The only required key within a project is *workflow*. This is important as you need to tell project which workflow to apply against the project. Any other variables specified here will be passed through to a workflow (more on this below).
|
|
39
46
|
|
|
47
|
+
|
|
48
|
+
|
|
40
49
|
==== Workflows
|
|
41
50
|
|
|
42
|
-
A workflow is a set of
|
|
51
|
+
A workflow is a set of commands you want run against a particular project. An example workflow might look something like this:
|
|
43
52
|
|
|
44
53
|
:default:
|
|
45
54
|
- cd %path
|
|
46
55
|
|
|
47
|
-
A workflow is just a YAML array of templated commands. Any variable used in a workflow will get looked up on the project that is running it. In the example above the %path variable has been replaced by the path
|
|
56
|
+
A workflow is just a YAML array of templated commands. Any variable used in a workflow will get looked up on the project that is running it. In the example above the %path variable has been replaced by the path specified within the project. Using this method you can quickly build up a set of common workflows to use against any project.
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
=== Running a project
|
|
60
|
+
|
|
61
|
+
Running a project is simple, just specify the name of the project you want to load and the workflow will run for it:
|
|
62
|
+
|
|
63
|
+
project name
|
|
64
|
+
|
|
65
|
+
|
|
48
66
|
|
|
49
67
|
== Bugs
|
|
50
68
|
|