Init

2018-03-02 18:20:44 +01:00 · 2018-03-02 18:20:44 +01:00 · 5cb02a356b
commit 5cb02a356b
4 changed files with 586 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,147 @@
+# cbrgm/drone-hugo
+
+[![GitHub release](https://img.shields.io/github/release/cbrgm/drone-hugo.svg)](https://github.com/cbrgm/drone-hugo/releases) ![](https://img.shields.io/badge/hugo%20version-3.7-ff69b4.svg) ![MicroBadger Size (tag)](https://img.shields.io/microbadger/image-size/cbrgm/drone-hugo/3.7.svg) [![Docker Pulls](https://img.shields.io/docker/pulls/cbrgm/drone-hugo.svg)](https://hub.docker.com/r/cbrgm/drone-hugo/tags/)
+
+**Automatically create static web page files using Hugo within your drone pipeline!**
+
+cbrgm/drone-hugo is:
+
+- **Easy** to implement in your existing pipeline using `.drone.yml`
+- **Small** 22mb 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: cbrgm/drone-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: cbrgm/drone-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: cbrgm/drone-hugo:latest
+    config: path/to/config
+    content: path/to/content/
+    output: path/to/public
+    source: path/to/source
+    theme: path/themes/THEMENAME/
+   url: https://cbrgm.de
+    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: cbrgm/drone-hugo:latest
+   buildDrafts: true
+   buildExpired: tru
+   buildFuture: true
+    config: path/to/config
+    content: path/to/content/
+    output: path/to/public
+    source: path/to/source
+    theme: path/themes/THEMENAME/
+    url: https://cbrgm.de
+    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: cbrgm/drone-hugo:latest
+    # secrets: [ SCP_USER, SCP_PASS, SCP_URL, SCP_PATH ]
+    output: public/drone-generated # Output path
+    validate: true
+    when:
+      branch: [ master ]
+  publish:
+    image: appleboy/drone-scp
+    host: cbrgm.de
+    username: webuser
+    password: xxxxxxx
+    port: 54321
+    rm: true
+    target: /var/www/blog
+    source: public/drone-generated/* # All files from output path
+
+```
+
+## Basic Usage using a Docker Container
+
+```bash
+docker run --rm \
+  -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) \
+  cbrgm/drone-hugo:latest
+```
+
+## Parameter Reference
+
+buildDrafts - include content marked as draft  
+buildExpired - include expired content  
+buildFuture - include content with publishdate in the future  
+config - config file (default is path/config.yaml|json|toml)  
+content - filesystem path to content directory  
+layout - filesystem path to layout directory
+output - filesystem path to write files to    
+source - filesystem path to read files relative from  
+theme - theme to use (located in /themes/THEMENAME/)
+url - hostname (and path) to the root  
+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.