nemunaire/drone-hugo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Unified documentation and readme

Browse Source
This commit is contained in:
Thomas Boerger 2019-02-15 11:58:37 +01:00
parent 3526b57b8b
commit 33d6f77854
No known key found for this signature in database
GPG Key ID: 09745AFF9D63C79B
4 changed files with 17 additions and 196 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -27,4 +27,4 @@ release/
vendor/ vendor/
coverage.out coverage.out
drone-hugo drone-hugo

167
DOCS.md
View File

@ -1,167 +0,0 @@
drone-hugo
[![GitHub release](https://img.shields.io/github/release/drone-plugins/drone-hugo.svg)](https://github.com/plugins/hugo/releases) ![](https://img.shields.io/badge/hugo%20version-v0.42-ff69b4.svg)
**Automatically create static web page files using Hugo within your drone pipeline!**
plugins/hugo is:
- **Easy** to implement in your existing pipeline using `.drone.yml`
- **Small** 21mb image size
- **Highly configurable**
## Basic Usage with Drone CI
The example below demonstrates how you can use the plugin to automatically create static web page files using Hugo. **It's as easy as pie!**
```yml
pipeline:
hugo:
image: plugins/hugo:latest
validate: true
```
`validate` allows you to check your configuration file for errors before generating the files.
### Customize source, output, theme, config, layout OR content directory paths
You can customize the paths for e. g. the theme, layout, content directory and output directory and much more!
```yml
pipeline:
hugo:
image: plugins/hugo:latest
+ config: path/to/config
+ content: path/to/content/
+ layout: path/to/layout
+ output: path/to/public
+ source: path/to/source
+ theme: path/themes/THEMENAME/
validate: true
```
### Set hostname (and path) to the root
You can also define a base URL directly in the pipeline, which is used when generating the files.
```yml
pipeline:
hugo:
image: plugins/hugo:latest
config: path/to/config
content: path/to/content/
output: path/to/public
source: path/to/source
theme: path/themes/THEMENAME/
+ url: https://example.com
validate: true
```
### Build sites and include expired, drafts or future content
You can set the `buildDrafts`, `buildExpired`, `buildFuture` settings to configure the generated files.
- `buildDrafts` - include content marked as draft
- `buildExpired` - include expired content
- `buildFuture` - include content with publishdate in the future
```yml
pipeline:
hugo:
image: plugins/hugo:latest
+ buildDrafts: true
+ buildExpired: true
+ buildFuture: true
config: path/to/config
content: path/to/content/
output: path/to/public
source: path/to/source
theme: path/themes/THEMENAME/
url: https://example.com
validate: true
```
### **Example**: Generate Hugo static files and publish them to remote directory using scp
Here is a short example of how to define a pipeline that automatically generates the static web page files with Hugo and then copies them to a remote server via scp. This makes publishing websites a breeze!
```yml
pipeline:
build:
image: plugins/hugo:latest
output: site # Output path
validate: true
when:
branch: [ master ]
publish:
image: appleboy/drone-scp
host: example.com
username: webuser
password: xxxxxxx
port: 54321
target: /var/www/ # Path to your web directory
source: site/* # Copy all files from output path
```
You can also use secrets to hide credentials:
```yml
pipeline:
build:
image: plugins/hugo:latest
output: site # Output path
validate: true
when:
branch: [ master ]
publish:
image: appleboy/drone-scp
+ secrets: [ ssh_username, ssh_password ]
host: example.com
- username: webuser
- password: xxxxxxx
port: 54321
target: /var/www/ # Path to your web directory
source: site/* # Copy all files from output path
```
## Basic Usage using a Docker Container
```bash
docker run --rm \
-e PLUGIN_VERSION=0.40.2 \
-e PLUGIN_BUILDDRAFTS=false \
-e PLUGIN_BUILDEXPIRED=false \
-e PLUGIN_BUILDFUTURE=false \
-e PLUGIN_CONFIG=false \
-e PLUGIN_CONTENT=false \
-e PLUGIN_LAYOUT=false \
-e PLUGIN_OUTPUT=false \
-e PLUGIN_SOURCE=false \
-e PLUGIN_THEME=false \
-e PLUGIN_OUTPUT=false \
-e PLUGIN_VALIDATE=false \
-v $(pwd):$(pwd) \
-w $(pwd) \
plugins/hugo:latest
```
## Parameter Reference
`hugoVersion` - the hugo version to be used, if not set use v.<HUGO_VERSION>
`buildDrafts` - include content marked as draft<br>
`buildExpired` - include expired content<br>
`buildFuture` - include content with publishdate in the future<br>
`config` - config file (default is path/config.yaml|json|toml)<br>
`content` - filesystem path to content directory<br>
`layout` - filesystem path to layout directory<br>
`output` - filesystem path to write files to<br>
`source` - filesystem path to read files relative from<br>
`theme` - theme to use (located in /themes/THEMENAME/)<br>
`url` - hostname (and path) to the root<br>
`validate` - validate config file before generation
## Contributing
You have suggestions for improvements or features you miss? You are welcome to express all your wishes here. Just create a new Issue and it will be taken care of quickly!
If you are a developer yourself, you can also contribute code! Further information will follow shortly.

20
Makefile
View File

@ -1,20 +0,0 @@
.PHONY: test build amd64 arm64 arm i386
test:
dep ensure
go test ./...
build: .drone.sh
./.drone.sh
amd64: Dockerfile
docker build -t "plugins/hugo:amd64" .
arm64: Dockerfile.arm64
docker build -t "plugins/hugo:arm64" .
arm: Dockerfile.arm
docker build -t "plugins/hugo:arm" .
arm: Dockerfile.i386
docker build -t "plugins/hugo:i386" .

24
README.md
View File

@ -8,27 +8,35 @@
[![Go Doc](https://godoc.org/github.com/drone-plugins/drone-hugo?status.svg)](http://godoc.org/github.com/drone-plugins/drone-hugo) [![Go Doc](https://godoc.org/github.com/drone-plugins/drone-hugo?status.svg)](http://godoc.org/github.com/drone-plugins/drone-hugo)
[![Go Report](https://goreportcard.com/badge/github.com/drone-plugins/drone-hugo)](https://goreportcard.com/report/github.com/drone-plugins/drone-hugo) [![Go Report](https://goreportcard.com/badge/github.com/drone-plugins/drone-hugo)](https://goreportcard.com/report/github.com/drone-plugins/drone-hugo)
Automatically create static web page files using [hugo](https://github.com/gohugoio/hugo) within your drone pipeline! For the usage information and a listing of the available options please take a look at [the docs](http://plugins.drone.io/drone-plugins/drone-hugo/). Automatically create static web page files using [Hugo](https://github.com/gohugoio/hugo) within your Drone pipeline. For the usage information and a listing of the available options please take a look at [the docs](http://plugins.drone.io/drone-plugins/drone-hugo/).
## Build ## Build
Build the binaries with the following commands: Build the binary with the following command:
```go ```console
make build export GOOS=linux
export GOARCH=amd64
export CGO_ENABLED=0
export GO111MODULE=on
go build -v -a -tags netgo -o release/linux/amd64/drone-hugo
``` ```
## Docker ## Docker
Build the Docker image with the following commands: Build the Docker image with the following command:
```bash ```console
make [amd64,arm64,amd] hugo=0.00.0 docker build \
--label org.label-schema.build-date=$(date -u +"%Y-%m-%dT%H:%M:%SZ") \
--label org.label-schema.vcs-ref=$(git rev-parse --short HEAD) \
--file docker/Dockerfile.linux.amd64 --tag plugins/hugo .
``` ```
### Usage ### Usage
```bash ```console
docker run --rm \ docker run --rm \
-e PLUGIN_HUGO_VERSION=0.00.0 \ -e PLUGIN_HUGO_VERSION=0.00.0 \
-e PLUGIN_BUILDDRAFTS=false \ -e PLUGIN_BUILDDRAFTS=false \