mirror of
https://github.com/gohugoio/hugo.git
synced 2024-07-02 15:20:28 +00:00
7829474088
This commit adds support for a configuration directory (default `config`). The different pieces in this puzzle are:
* A new `--environment` (or `-e`) flag. This can also be set with the `HUGO_ENVIRONMENT` OS environment variable. The value for `environment` defaults to `production` when running `hugo` and `development` when running `hugo server`. You can set it to any value you want (e.g. `hugo server -e "Sensible Environment"`), but as it is used to load configuration from the file system, the letter case may be important. You can get this value in your templates with `{{ hugo.Environment }}`.
* A new `--configDir` flag (defaults to `config` below your project). This can also be set with `HUGO_CONFIGDIR` OS environment variable.
If the `configDir` exists, the configuration files will be read and merged on top of each other from left to right; the right-most value will win on duplicates.
Given the example tree below:
If `environment` is `production`, the left-most `config.toml` would be the one directly below the project (this can now be omitted if you want), and then `_default/config.toml` and finally `production/config.toml`. And since these will be merged, you can just provide the environment specific configuration setting in you production config, e.g. `enableGitInfo = true`. The order within the directories will be lexical (`config.toml` and then `params.toml`).
```bash
config
├── _default
│ ├── config.toml
│ ├── languages.toml
│ ├── menus
│ │ ├── menus.en.toml
│ │ └── menus.zh.toml
│ └── params.toml
├── development
│ └── params.toml
└── production
├── config.toml
└── params.toml
```
Some configuration maps support the language code in the filename (e.g. `menus.en.toml`): `menus` (`menu` also works) and `params`.
Also note that the only folders with "a meaning" in the above listing is the top level directories below `config`. The `menus` sub folder is just added for better organization.
We use `TOML` in the example above, but Hugo also supports `JSON` and `YAML` as configuration formats. These can be mixed.
Fixes #5422
67 lines
1.4 KiB
YAML
67 lines
1.4 KiB
YAML
project_name: hugo
|
|
build:
|
|
main: main.go
|
|
binary: hugo
|
|
ldflags: -s -w -X github.com/gohugoio/hugo/common/hugo.buildDate={{.Date}} -X github.com/gohugoio/hugo/common/hugo.commitHash={{ .ShortCommit }}
|
|
env:
|
|
- CGO_ENABLED=0
|
|
goos:
|
|
- darwin
|
|
- linux
|
|
- windows
|
|
- freebsd
|
|
- netbsd
|
|
- openbsd
|
|
- dragonfly
|
|
goarch:
|
|
- amd64
|
|
- 386
|
|
- arm
|
|
- arm64
|
|
goarm:
|
|
- 7
|
|
nfpm:
|
|
formats:
|
|
- deb
|
|
vendor: "gohugo.io"
|
|
homepage: "https://gohugo.io/"
|
|
maintainer: "Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>"
|
|
description: "A Fast and Flexible Static Site Generator built with love in GoLang."
|
|
license: "Apache 2.0"
|
|
name_template: "{{.ProjectName}}_{{.Version}}_{{.Os}}-{{.Arch}}"
|
|
replacements:
|
|
amd64: 64bit
|
|
386: 32bit
|
|
arm: ARM
|
|
arm64: ARM64
|
|
darwin: macOS
|
|
linux: Linux
|
|
windows: Windows
|
|
openbsd: OpenBSD
|
|
netbsd: NetBSD
|
|
freebsd: FreeBSD
|
|
dragonfly: DragonFlyBSD
|
|
archive:
|
|
format: tar.gz
|
|
format_overrides:
|
|
- goos: windows
|
|
format: zip
|
|
name_template: "{{.ProjectName}}_{{.Version}}_{{.Os}}-{{.Arch}}"
|
|
replacements:
|
|
amd64: 64bit
|
|
386: 32bit
|
|
arm: ARM
|
|
arm64: ARM64
|
|
darwin: macOS
|
|
linux: Linux
|
|
windows: Windows
|
|
openbsd: OpenBSD
|
|
netbsd: NetBSD
|
|
freebsd: FreeBSD
|
|
dragonfly: DragonFlyBSD
|
|
files:
|
|
- README.md
|
|
- LICENSE
|
|
release:
|
|
draft: true
|