https://github.com/uetchy/wercker-step-gh-pages
Deploy to Github Pages via Wercker.
https://github.com/uetchy/wercker-step-gh-pages
Last synced: about 1 year ago
JSON representation
Deploy to Github Pages via Wercker.
- Host: GitHub
- URL: https://github.com/uetchy/wercker-step-gh-pages
- Owner: uetchy
- License: mit
- Created: 2015-07-08T03:55:52.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2016-01-23T06:35:03.000Z (over 10 years ago)
- Last Synced: 2025-03-29T11:34:41.938Z (about 1 year ago)
- Language: Shell
- Homepage:
- Size: 6.84 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wercker-step-gh-pages
Deploy to Github Pages with Wercker.
## Usage
Put __uetchy/gh-pages__ step into your wercker.yml.
Please make sure your wercker-box contains 'git' command.
### Example(Docker stack)
```yaml
box: golang:1.5.1
build:
steps:
- script:
name: initialize git submodules
code: |
git submodule update --init --recursive
- arjen/hugo-build:
theme: hugo-paper
flags: --buildDrafts=false
disable_pygments: true
deploy:
steps:
- uetchy/gh-pages:
token: $GITHUB_TOKEN
repo: randompaper/randompaper.github.io
domain: randompaper.co
path: public
```
### Example(Classic stack)
```yaml
box: wercker/default
build:
steps:
- arjen/hugo-build:
theme: hugo-paper
flags: --buildDrafts=false
disable_pygments: true
deploy:
steps:
- uetchy/gh-pages:
token: $GITHUB_TOKEN
repo: randompaper/randompaper.github.io
domain: randompaper.co
path: public
```
Then set your Github [Personal Access Token](https://github.com/settings/tokens) as environment variables.
Finally, you will be able to deploy to Github Pages.
## Options
|name|description|optional|
|----|-----------|--------|
|token|Github token|false|
|repo|Destination repository|true/false|
|domain|Custom domain|true|
|path|Root dir|true|