Preserve homedir template variable for backwards compatibility

lmf-mx · Mar 16, 2021 · 784a08c · 784a08c
1 parent 49ee6bc
commit 784a08c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/cmd/config.go b/cmd/config.go
@@ -492,6 +492,7 @@ func (c *Config) defaultTemplateData() map[string]interface{} {
 	data := map[string]interface{}{
 		"arch":      runtime.GOARCH,
 		"homeDir":   c.homeDir,
+		"homedir":   c.homeDir, // TODO Remove in version 2.1.
 		"os":        runtime.GOOS,
 		"sourceDir": c.sourceDirAbsPath,
 		"version": map[string]interface{}{

diff --git a/docs/CHANGES.md b/docs/CHANGES.md
@@ -104,7 +104,8 @@ the new functionality and for consistency:
 * The gpg recipient is configured with the `gpg.recipient` configuration
   variable, `gpgRecipient` is no longer used.
 * The structure of data output by `chezmoi dump` has changed.
-* The `.chezmoi.homedir` template variable has been renamed to
-  `.chezmoi.homeDir`.
+* The `.chezmoi.homedir` template variable has been replaced with
+  `.chezmoi.homeDir`. For compatibility, `.chezmoi.homedir` will continue to be
+  supported until version 2.1.
 * The `.chezmoi.fullHostname` template variable has been removed, as it did not
   contain the full hostname,