Advanced configuration
All configuration files use the TOML format.
Configuration is read from the following files, in order. Last files overwrite values in previous one. Linux
$HOME/.config/highflux/config
<REPO>/.highflux/config
macOS
$HOME/Library/Application Support/highflux/config
<REPO>/.highflux/config
Windows
{FOLDERID_RoamingAppData}\highflux\config (e.g. C:\Users\Alice\AppData\Roaming\highflux\config)
<REPO>\.highflux\config
After that, any environment variable starting with HF_
overwrites any configuration value.
note
We advise you to send us a message on slack before changing any of these values, as that will more likely get you what you want. You should consider changing these values manually as experimental!
Configuration Key | Default Value | Notes |
---|---|---|
wip_branches_prefix | wip/ | Prefix of WIP branches |
default_commit_message | Commit generated by HighFlux.io | This appears in the commit on your WIP's storage branch |
current_wip_prefix | current-wip/ | Current WIP branch prefix |
user_initials | Extracted from your git username | Used as prefix for all of the user’s WIPs. E.g. for Bill Gates, the user-initials will be BG |
review_branch_prefix | review/ | The prefix of the review branch that is created for code-reviews. |
hide_file_prefix | _hide_ | Any file name that starts with this string is automatically hidden. |