Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/khos2ow/hugo-wrapper
The universal way to include Hugo binary to your project.
https://github.com/khos2ow/hugo-wrapper
binary hugo hugo-wrapper wrapper
Last synced: 3 months ago
JSON representation
The universal way to include Hugo binary to your project.
- Host: GitHub
- URL: https://github.com/khos2ow/hugo-wrapper
- Owner: khos2ow
- License: apache-2.0
- Created: 2018-07-10T18:46:06.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-13T06:42:35.000Z (over 1 year ago)
- Last Synced: 2024-10-29T21:06:37.472Z (3 months ago)
- Topics: binary, hugo, hugo-wrapper, wrapper
- Language: Shell
- Homepage:
- Size: 465 KB
- Stars: 31
- Watchers: 3
- Forks: 12
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hugo Wrapper
`hugow` is a POSIX-style shell script which acts as a wrapper to download and run [Hugo](https://gohugo.io/)
binary - which is, in fact, [platform dependent](https://gohugo.io/getting-started/installing/#binary-cross-platform) -
for your platform. It can be executed in variety of [Operating Systems](#tested-on) and
[Command Shells](#tested-on).
## Table of contents
- [Hugo Wrapper dependencies](#hugo-wrapper-dependencies)
- [Download Hugo Wrapper](#download-hugo-wrapper)
- [Upgrade Hugo Wrapper](#upgrade-hugo-wrapper)
- [Hugo Wrapper usage](#hugo-wrapper-usage)
- [Hugo Wrapper flags](#hugo-wrapper-flags)
- [Download Hugo binary](#download-hugo-binary)
- [Download specific Hugo binary](#download-specific-hugo-binary)
- [Download specific Hugo Extended binary](#download-specific-hugo-extended-binary)
- [Content of `.gitignore`](#content-of-gitignore)
- [Tested on](#tested-on)
- [License](#license)
## Hugo Wrapper dependencies
`hugow` has very minimal number of dependencies:
- downloader: `wget` or `curl`
- checksum: `sha256sum` or `shasum` or `cksum`
- tarball: `tar`
## Download Hugo Wrapper
In order to use the `hugow` binary, you only need to download it and place it in the root
of your Hugo project.
```bash
curl -L -o hugow https://github.com/khos2ow/hugo-wrapper/releases/download/v1.6.0/hugow && chmod +x hugow
```
or
```bash
wget -O hugow https://github.com/khos2ow/hugo-wrapper/releases/download/v1.6.0/hugow && chmod +x hugow
```
## Upgrade Hugo Wrapper
In order to upgrade `hugow` binary, you can use `--upgrade` flag. The newest version of
wrapper binary will be downloaded from GitHub repository on your machine and will replace
the old one.
```bash
./hugow --upgrade
```
## Hugo Wrapper usage
and use it the same way you'd use Hugo binary itself:
```bash
./hugow # to build the site
./hugow server # to start the server
./hugow --help # to show help of both Hugo and Hugo Wrapper
```
On the first execution, `hugow` downloads the _latest_ Hugo binary from
[official releases](https://github.com/gohugoio/hugo/releases) and caches it locally as
`/.hugo/hugo` and also keeps track of the downloaded version in
`/.hugo/version`. As a result from the second execution forward it will only
execute the - already downloaded - binary.
## Hugo Wrapper flags
`hugow` supports the following flags and passes through any additional flag directly to
Hugo binary itself.
```text
Flags:
--get-extended get hugo extended binary
--get-latest get latest version of hugo binary
--get-version string get specified version of hugo binary
--upgrade upgrade hugo wrapper binary itself
-h, --help help for hugo-wrapper
```
## Hugo Wrapper CI/CD
Most Continuous delivery platforms need a silent build command that will produce valid exit codes. Here are some examples of using `hugow` in the wild.
### Netlify
Netlify will need permission to use `hugow` and run the build
```bash
chmod a+x ./hugow && ./hugow --gc --minify --quiet
```
## Download Hugo binary
With `hugow` you can download `LATEST` or specific version of Hugo binary or Hugo Extended
binary, and you can upgrade or downgrade at any given time.
### Download specific Hugo binary
```bash
./hugow --get-latest # to get latest Hugo version
./hugow --get-version # to get specific Hugo version
```
### Download specific Hugo Extended binary
```bash
./hugow --get-extended --get-latest # to get latest Hugo extended version
./hugow --get-extended --get-version # to get specific Hugo extended version
./hugow --get-version /extended # to get specific Hugo extended version (alias)
```
## Content of `.gitignore`
`.hugo` folder in `PROJECT_ROOT` which contains downloaded Hugo binary and the `version`
should be added to `.gitignore`. Note that this is usually good enough, and it makes
your user to easily access Hugo binary without needing to actually go and download
specific version based on their OS and CPU architecture.
example `.gitignore` content:
```gitignore
.hugo
```
But if you need a fine grained control of which version of Hugo is intended to be used
for your project, or if you need an absolute fixed version of Hugo to be used everywhere
(on user machine, CI job container, etc) you need to check in the `.hugo/version` into
your project repository as well to ensure consistence Hugo version everywhere.
example `.gitignore` content:
```gitignore
.hugo/*
!.hugo/version
```
## Tested on
Operating Systems | Architecture | bash | sh | csh | tcsh | zsh | ksh | PowerShell |
-------------------|--------------|------|----|-----|------|-----|-----|------------|
DragonFloyBSD | amd64 | - | - | - | - | - | - | - |
FreeBSD | i386 | - | - | - | - | - | - | - |
FreeBSD | amd64 | ✔ | ✔ | ✔ | ✔ | ✔ | - | - |
FreeBSD | ARM | - | - | - | - | - | - | - |
Linux | x86 | - | - | - | - | - | - | - |
Linux | x86_64 | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | - |
Linux | ARM | - | - | - | - | - | - | - |
Linux | ARM64 | - | - | - | - | - | - | - |
macOS | x86 | - | - | - | - | - | - | - |
macOS | x86_64 | ✔ | - | - | - | - | - | - |
macOS | ARM | - | - | - | - | - | - | - |
macOS | ARM64 | - | - | - | - | ✔︎ | - | - |
NetBSD | i386 | - | - | - | - | - | - | - |
NetBSD | amd64 | - | - | - | - | - | ✔ | - |
NetBSD | ARM | - | - | - | - | - | - | - |
OpenBSD | i386 | - | - | - | - | - | - | - |
OpenBSD | amd64 | - | - | - | - | - | - | - |
## License
Licensed under [Apache License version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
Please see the [LICENSE](https://github.com/khos2ow/hugo-wrapper/blob/master/LICENSE)
file included in the root directory of the source tree for extended license details.