octopress-deploy 1.0.0.alpha.0 → 1.0.0.alpha.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +9 -6
- data/lib/octopress-deploy/git.rb +2 -0
- data/lib/octopress-deploy/version.rb +1 -1
- data/test/test.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 10f414864560fd38076f95cf3ac0b16400794a6c
|
4
|
+
data.tar.gz: 5ee9dd24d6a7df9ffc0215377cbdc99562138c57
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c251e5f0f1ceb90e2a29964cd73f1ba9fea345512a839c0f61d39bcefa78bd522101cc47c843c0b8707dea95b65bcc9ccb0745f44343e294c4823b056af4b753
|
7
|
+
data.tar.gz: 332ec18880beaa38605ca0c362cf2a5290d315a7a869c0592f12dc23074af4574bb2e8f5b64509714d0cb15afe588c5ff8a81281006457769d1f6dc6c55cf4bc
|
data/README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
|
-
# Octopress
|
1
|
+
# Octopress Deploy
|
2
2
|
|
3
|
-
|
3
|
+
Deployment tools for Octopress and Jekyll blogs.
|
4
4
|
|
5
5
|
## Installation
|
6
6
|
|
@@ -20,7 +20,9 @@ Or install it yourself as:
|
|
20
20
|
|
21
21
|
This is a generic git deployment system, it should work for GitHub, Heroku and other similar hosts.
|
22
22
|
|
23
|
-
#### 1. Add a
|
23
|
+
#### 1. Add a configuration file
|
24
|
+
|
25
|
+
Create a file named `_deploy.yml` in your project root.
|
24
26
|
|
25
27
|
For GitHub user pages, the url should be something like: `git@github.com:username.github.io` and the branch should be master.
|
26
28
|
For project pages, the url should be the path to the project repo and the branch should be `gh-pages`.
|
@@ -28,16 +30,18 @@ For project pages, the url should be the path to the project repo and the branch
|
|
28
30
|
```yml
|
29
31
|
site: _site
|
30
32
|
git:
|
31
|
-
url:
|
33
|
+
url:
|
32
34
|
branch: master
|
33
35
|
```
|
34
36
|
|
35
|
-
#### 2. From Ruby run
|
37
|
+
#### 2. From Ruby run
|
36
38
|
|
37
39
|
```ruby
|
38
40
|
Octopress::Deploy::Git.new().push
|
39
41
|
```
|
40
42
|
|
43
|
+
If you do not have a config file set up yet, this will offer to create a default one for you.
|
44
|
+
|
41
45
|
### Options
|
42
46
|
|
43
47
|
It is recommended that you configure using the `deploy.yml`, but you can also pass configuration as options.
|
@@ -51,7 +55,6 @@ It is recommended that you configure using the `deploy.yml`, but you can also pa
|
|
51
55
|
| `deploy_dir` | Directory where deployment files are staged. | .deploy |
|
52
56
|
| `remote` | Name of git remote. | deploy |
|
53
57
|
|
54
|
-
|
55
58
|
## Contributing
|
56
59
|
|
57
60
|
1. Fork it
|
data/lib/octopress-deploy/git.rb
CHANGED
@@ -12,6 +12,8 @@ module Octopress
|
|
12
12
|
@branch = options[:git_branch] || config['git']['branch']
|
13
13
|
@deploy_dir = options[:deploy_dir] || config['git']['deploy_dir'] || '.deploy'
|
14
14
|
@remote = options[:remote] || config['git']['remote'] || 'deploy'
|
15
|
+
|
16
|
+
abort "Deploy Failed: You must provide a repository URL before deploying. Check your #{@config_file}.".red if @repo.nil?
|
15
17
|
end
|
16
18
|
end
|
17
19
|
|
data/test/test.rb
CHANGED