Skip to content

Uses a pre-push git hook to deploy compiled assets from a jekyll project to gh-pages for static site hosting

Notifications You must be signed in to change notification settings

jimafisk/gh-pages_deploy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 

Repository files navigation

gh-pages_deploy

Uses a pre-push git hook to deploy compiled assets from a jekyll project to gh-pages for static site hosting

Setup

1.) Download "pre-push" file from this repository
2.) Put "pre-push" file in the hooks directory of your git enabled project so it appears like so:
.git/hooks/pre-push
3.) Make sure the script is executable:
chmod u+x .git/hooks/pre-push
4.) Make sure your _site folder is being tracked by commenting out or removing the "_site" line in your .gitignore file
5.) Make changes to your Jekyll project
6.) Compile your static site assets by running jekyll serve
7.) Add and commit changes
8.) Push your master branch via the terminal and you should be prompted whether or not to deploy (input "y" for yes).

Note 1: If you don't already have a gh-pages branch on your remote repo, you might get an error like this:

error: unable to push to unqualified destination: gh-pages
The destination refspec neither matches an existing ref on the remote nor
begins with refs/, and we are unable to guess a prefix based on the source ref.
error: failed to push some refs to '[email protected]:yourorg/yourproject.git'

You should manually create a new branch on Github (Just click on where it says Branch: master in the top left of your repository, start searching for gh-pages and it will prompt you to create a new branch with that name).

Note 2: If you just created a new gh-pages branch on github, it will contain all the project files, and not just the built assets, so you may need to add the --force flag to do your initial push.

Note 3: If using fishshell, replace the backtick characters " ` " with paranthesis " ( ". Example: git push origin (git subtree split --prefix _site master):gh-pages --force --no-verify

About

Uses a pre-push git hook to deploy compiled assets from a jekyll project to gh-pages for static site hosting

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages