emelie/zola
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Universalize the GitHub pages publishing scheme (#780)

Browse source 
Added instructions on how to publish to <username>.github.io or <org>.github.io by changing the publishing branch in the repo to `master`. This should work for any type of GitHub publishing, including custom domains.

Fixes #765
This commit is contained in:
Daniel Egger 2019-08-24 19:06:07 +02:00 committed by Vincent Prouillet
parent 4fff7508ba
commit beb5a3af41
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/content/documentation/deployment/github-pages.md
View file

@ -4,8 +4,7 @@ weight = 30
+++ +++
By default, GitHub Pages uses Jekyll (A ruby based static site generator), By default, GitHub Pages uses Jekyll (A ruby based static site generator),
but you can use whatever you want provided you have an `index.html` file in the root of a branch called `gh-pages`. but you can also publish any generated files provided you have an `index.html` file in the root of a branch called `gh-pages` or `master`, in addition you can also publish from a `docs` directory in your repository. That branch name can also be manually changed in the settings of a repository. **However** this only applies to publishing in a custom domain, i.e. if you want to publish to a GitHub provided web service under the `github.io` domain, you can **only** use the `master` branch of your repository as explained [here](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages), so we will focus on the method which will work regardless of the domain.
That branch name can also be manually changed in the settings of a repository.
We can use any CI server to build and deploy our site. For example: We can use any CI server to build and deploy our site. For example:
@ -45,6 +44,8 @@ Make sure "Display value in build log" is off, and then click add. Now Travis ha
We're almost done. We just need some scripts in a .travis.yml file to tell Travis what to do. We're almost done. We just need some scripts in a .travis.yml file to tell Travis what to do.
**NOTE**: The script below assumes that we're taking the code from the `code` branch and will generate the HTML to be published in the `master` branch of the same repository. You're free to use any other branch for the Markdown files but if you want to use `<username>.github.io` or `<org>.github.io`, the destination branch **MUST** be `master`.
```yaml ```yaml
language: minimal language: minimal
@ -59,12 +60,12 @@ script:
# If you are using a different folder than `public` for the output directory, you will # If you are using a different folder than `public` for the output directory, you will
# need to change the `zola` command and the `ghp-import` path # need to change the `zola` command and the `ghp-import` path
after_success: | after_success: |
[ $TRAVIS_BRANCH = master ] && [ $TRAVIS_BRANCH = code ] &&
[ $TRAVIS_PULL_REQUEST = false ] && [ $TRAVIS_PULL_REQUEST = false ] &&
zola build && zola build &&
sudo pip install ghp-import && sudo pip install ghp-import &&
ghp-import -n public && ghp-import -n public -b master &&
git push -fq https://${GH_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git gh-pages git push -fq https://${GH_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git master
``` ```
If your site is using a custom domain, you will need to mention it in the `ghp-import` command: `ghp-import -c vaporsoft.net -n public` If your site is using a custom domain, you will need to mention it in the `ghp-import` command: `ghp-import -c vaporsoft.net -n public`