1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
## Using Hakyll with GitHub Pages
[GitHub Pages](http://pages.github.com) has become a popular static website hosting solution due to its simplicity. Simply push a couple files to a repository and it's off to the races.
Working with Hakyll on a GitHub Pages-hosted website is complicated slightly due to Hakyll outputting files to a ```_site``` subdirectory, our desire to have the source code as well as the compiled site stored in a single repository, and our desire to automate it.
This guide will walkthrough the creation and setup of a GitHub site that has two independent branches.
1. ```master``` - This is where your site lives. It's what you see when you go to ```https://<your repo>.github.io```. This branch *needs* to be called master.
2. ```develop``` - This is where your website's source is. That's all your Haskell code, your posts and templates, etc, and it's where you do work from. This name was chosen arbitrarily and can be freely substituted for any name of your choosing.
When you're finished, you will be able to, with one command, refresh your website's contents and send any changes to your GitHub Page.
In the interest of keeping this guide as simple as possible, I'll be making a few assumptions.
1. Haskell is being used with [Stack](http://docs.haskellstack.org/en/stable/README/).
2. Creating a user/organization site (vice a project site).
3. You haven't changed Hakyll's default output directory of '_site/'.
These instructions should be easy to adapt for any situation though.
### GitHub Setup
1. If required, create a new repository for your blog.
2. If required, create a ```master``` branch.
2. If applicable/desired, create/add to your repository any files that your site needs that will not be produced by your Hakyll project. For example, ```CNAME``` as outlined [here](https://help.github.com/articles/setting-up-your-pages-site-repository/).
3. Create a ```.gitignore``` file with at a minimum, the following entries:
```
_cache/
_site/
.stack-work/
```
### Local setup
1. If required, create a new Hakyll project. If you're a stack user, there is a Hakyll template available that makes this step easy.
```stack new myblog hakyll-template```
2. Create a ```.gitignore``` file in your blog's directory with at a minimum, the same directories listed as in the GitHub repository.
3. Use the following git commands to setup your local repository.
```
git init
# create new branch called develop and switch to it.
git checkout -b develop
# track all the source files for our blog.
git add .
# make our first commit
git commit -m "initial commit."
# and add the GitHub repository as a remote.
git remote add origin <URL to your GitHub pages repository>
```
### Deployment
So everything's all setup and we're ready to deploy.
> Note: Performing the following commands from your ```develop``` branch is recommended since you will end up back in that branch at the end.
Temporarily save any uncommitted changes that may exist in the current branch.
```
git stash
```
Ensure we are in the correct branch.
```
git checkout develop
```
Get a clean build of our site.
```
stack exec myblog clean
stack exec myblog build
```
Update the local list of remote branches to ensure we're able to checkout the branch we want in the next step.
```
git fetch -all
```
Switches to a new branch called "publish" that tracks the origin "master" branch. **Note:** Checking out the publish branch does not overwrite the files that Hakyll just produced because we have '_site' in both .gitignore files.
```
git checkout -b publish --track origin/master
```
Copy the freshly made contents of '_site' over the old ones. Note that if a file is *no longer* being produced (for example if you deleted a blog posting), it will continue to persist in your published site until it's been removed from that repository as well.
```
cp -a _site/. .
```
Commit our changes.
```
git add -A
git commit -m "publish."
```
And send them to GitHub.
```
git push origin publish:master
```
Final clean up and return to the original state.
```
git checkout develop
git branch -D publish
git stash pop
```
### *And that's it.*
A full listing of the "script" is available [here](https://gist.github.com/narrative/5edb976b2f8754a79104).
|
