Merge pull request #1373 from twpayne/tidy-docs

Miscellaneous fixes
twpayne · Aug 29, 2021 · df24ba4 · df24ba4
2 parents 1b30fc5 + 49c34ea
commit df24ba4
Show file tree

Hide file tree

Showing 37 changed files with 710 additions and 212 deletions.
diff --git a/.cirrus.yml b/.cirrus.yml
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -165,7 +165,7 @@ jobs:
     - name: ShellCheck
       uses: ludeeus/[email protected]
       with:
-        scandir: ./assets/scripts
+        ignore: completions
     - name: Whitespace
       run: go run ./internal/cmds/lint-whitespace
     - name: Typos

diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 *.exe
+/.vagrant
 /bin/chezmoi
 /bin/gofumports
 /bin/golangci-lint

diff --git a/Makefile b/Makefile
@@ -9,47 +9,51 @@ build: build-darwin build-freebsd build-linux build-windows
 
 .PHONY: build-darwin
 build-darwin:
-	GOOS=darwin GOARCH=amd64 $(GO) build -o /dev/null .
-	GOOS=darwin GOARCH=arm64 $(GO) build -o /dev/null .
+	GOOS=darwin GOARCH=amd64 ${GO} build -o /dev/null .
+	GOOS=darwin GOARCH=arm64 ${GO} build -o /dev/null .
 
 .PHONY: build-freebsd
 build-freebsd:
-	GOOS=freebsd GOARCH=amd64 $(GO) build -o /dev/null .
+	GOOS=freebsd GOARCH=amd64 ${GO} build -o /dev/null .
 
 .PHONY: build-linux
 build-linux:
-	GOOS=linux GOARCH=amd64 $(GO) build -o /dev/null .
-	GOOS=linux GOARCH=amd64 $(GO) build -tags=noupgrade -o /dev/null .
+	GOOS=linux GOARCH=amd64 ${GO} build -o /dev/null .
+	GOOS=linux GOARCH=amd64 ${GO} build -tags=noupgrade -o /dev/null .
 
 .PHONY: build-windows
 build-windows:
-	GOOS=windows GOARCH=amd64 $(GO) build -o /dev/null .
+	GOOS=windows GOARCH=amd64 ${GO} build -o /dev/null .
 
 .PHONY: run
 run:
-	$(GO) run . --version
+	${GO} run . --version
 
 .PHONY: test
 test:
-	$(GO) test -ldflags="-X github.com/twpayne/chezmoi/internal/chezmoitest.umaskStr=0o022" ./...
-	$(GO) test -ldflags="-X github.com/twpayne/chezmoi/internal/chezmoitest.umaskStr=0o002" ./...
+	${GO} test -ldflags="-X github.com/twpayne/chezmoi/internal/chezmoitest.umaskStr=0o022" ./...
+	${GO} test -ldflags="-X github.com/twpayne/chezmoi/internal/chezmoitest.umaskStr=0o002" ./...
+
+.PHONY: test-os
+test-os:
+	( cd assets/vagrant && ./test.sh fedora33 freebsd13 openbsd6 )
 
 .PHONY: coverage-html
 coverage-html: coverage
-	$(GO) tool cover -html=coverage.out
+	${GO} tool cover -html=coverage.out
 
 .PHONY: coverage
 coverage:
-	$(GO) test -test.coverprofile=coverage.out ./...
+	${GO} test -test.coverprofile=coverage.out ./...
 
 .PHONY: generate
 generate:
-	$(GO) generate
+	${GO} generate
 
 .PHONY: lint
 lint: ensure-golangci-lint
 	./bin/golangci-lint run
-	$(GO) run ./internal/cmds/lint-whitespace
+	${GO} run ./internal/cmds/lint-whitespace
 
 .PHONY: format
 format: ensure-gofumports
@@ -62,7 +66,7 @@ ensure-tools: ensure-gofumports ensure-golangci-lint
 ensure-gofumports:
 	if [ ! -x bin/gofumports ] ; then \
 		mkdir -p bin ; \
-		GOBIN=$(shell pwd)/bin $(GO) install mvdan.cc/gofumpt/gofumports@latest ; \
+		GOBIN=$(shell pwd)/bin ${GO} install mvdan.cc/gofumpt/gofumports@latest ; \
 	fi
 
 .PHONY: ensure-golangci-lint

diff --git a/README.md b/README.md
@@ -17,6 +17,8 @@ Updating your dotfiles on any machine is a single command:
 $ chezmoi update
 ```
 
+---
+
 * [How do I start with chezmoi now?](#how-do-i-start-with-chezmoi-now)
 * [What does chezmoi do and why should I use it?](#what-does-chezmoi-do-and-why-should-i-use-it)
 * [What are chezmoi's key features?](#what-are-chezmois-key-features)
@@ -32,6 +34,7 @@ $ chezmoi update
 * [What documentation is available?](#what-documentation-is-available)
 * [License](#license)
 
+---
 ## How do I start with chezmoi now?
 
 [Install chezmoi](docs/INSTALL.md) then read the [quick start
@@ -44,6 +47,7 @@ GitLab](https://gitlab.com/search?search=chezmoi), and see how chezmoi [compares
 to other dotfile managers](docs/COMPARISON.md). For a full description of
 chezmoi, consult the [reference](docs/REFERENCE.md).
 
+---
 ## What does chezmoi do and why should I use it?
 
 chezmoi helps you manage your personal configuration files (dotfiles, like
@@ -71,6 +75,8 @@ If you do not personalize your configuration or only ever use a single operating
 system with a single account and none of your dotfiles contain secrets then you
 don't need chezmoi. Otherwise, read on...
 
+---
+
 ## What are chezmoi's key features?
 
 ### Flexible
@@ -123,10 +129,14 @@ commands, including installation, initialization, and keeping your machines
 up-to-date. chezmoi can pull and apply changes from your dotfiles repo in a
 single command, and automatically commit and push changes.
 
+---
+
 ## I already have a system to manage my dotfiles, why should I use chezmoi?
 
 Read the [comparison of chezmoi to other dotfile managers](docs/COMPARISON.md).
 
+---
+
 ## How do people use chezmoi?
 
 ### Dotfile repos using chezmoi
@@ -139,6 +149,8 @@ GitLab](https://gitlab.com/search?search=chezmoi).
 
 Read what [people have said about chezmoi](docs/MEDIA.md).
 
+---
+
 ## What documentation is available?
 
 * [Install guide](docs/INSTALL.md) to get chezmoi installed on your machine with
@@ -156,6 +168,10 @@ Read what [people have said about chezmoi](docs/MEDIA.md).
 * [Contributing](docs/CONTRIBUTING.md) and [Architecture](docs/ARCHITECTURE.md)
   for people looking to contribute to or package chezmoi.
 
+---
+
 ## License
 
 MIT
+
+---
diff --git a/assets/chezmoi.io/content/_index.md b/assets/chezmoi.io/content/_index.md
@@ -20,6 +20,8 @@ Updating your dotfiles on any machine is a single command:
 $ chezmoi update
 ```
 
+---
+
 ## How do I start with chezmoi now?
 
 [Install chezmoi](/docs/install/) then read the [quick start
@@ -32,6 +34,8 @@ GitLab](https://gitlab.com/search?search=chezmoi), and see how chezmoi [compares
 to other dotfile managers](/docs/comparison/). For a full description of
 chezmoi, consult the [reference](/docs/reference/).
 
+---
+
 ## What does chezmoi do and why should I use it?
 
 chezmoi helps you manage your personal configuration files (dotfiles, like
@@ -59,6 +63,8 @@ If you do not personalize your configuration or only ever use a single operating
 system with a single account and none of your dotfiles contain secrets then you
 don't need chezmoi. Otherwise, read on...
 
+---
+
 ## What are chezmoi's key features?
 
 ### Flexible
@@ -111,10 +117,14 @@ commands, including installation, initialization, and keeping your machines
 up-to-date. chezmoi can pull and apply changes from your dotfiles repo in a
 single command, and automatically commit and push changes.
 
+---
+
 ## I already have a system to manage my dotfiles, why should I use chezmoi?
 
 Read the [comparison of chezmoi to other dotfile managers](/docs/comparison/).
 
+---
+
 ## How do people use chezmoi?
 
 ### Dotfile repos using chezmoi
@@ -127,6 +137,8 @@ GitLab](https://gitlab.com/search?search=chezmoi).
 
 Read what [people have said about chezmoi](/docs/media/).
 
+---
+
 ## What documentation is available?
 
 * [Install guide](/docs/install/) to get chezmoi installed on your machine with
@@ -144,6 +156,10 @@ Read what [people have said about chezmoi](/docs/media/).
 * [Contributing](/docs/contributing/) and [Architecture](/docs/architecture/)
   for people looking to contribute to or package chezmoi.
 
+---
+
 ## License
 
 MIT
+
+---
diff --git a/assets/chezmoi.io/make-gh-pages.sh b/assets/chezmoi.io/make-gh-pages.sh
@@ -7,21 +7,20 @@ rm -rf public/
 hugo
 
 # clone and checkout the gh-pages branch in a temporary directory
-oldwd=$(pwd)
 tmpdir=$(mktemp -d)
 cleanup() {
-    rm -rf ${tmpdir}
+    rm -rf "${tmpdir}"
 }
 trap cleanup EXIT
 git branch -f gh-pages origin/gh-pages
-git clone --branch=gh-pages --local ../.. ${tmpdir}
+git clone --branch=gh-pages --local ../.. "${tmpdir}"
 
 # copy the new website to the temporary directory
-rm -rf ${tmpdir}/*
-cp -r public/* ${tmpdir}
+rm -rf "${tmpdir:?}"/*
+cp -r public/* "${tmpdir}"
 
 # prepare the clone
-cd ${tmpdir}
+cd "${tmpdir}"
 git checkout CNAME
 git remote set-url origin https://github.com/twpayne/chezmoi.git
 git fetch origin

diff --git a/assets/vagrant/fedora33.Vagrantfile b/assets/vagrant/fedora33.Vagrantfile
@@ -0,0 +1,9 @@
+Vagrant.configure("2") do |config|
+  config.vm.box = "generic/fedora33"
+  config.vm.hostname = "fedora33"
+  config.vm.synced_folder ".", "/chezmoi", type: "rsync"
+  config.vm.provision "shell", inline: <<-SHELL
+    yum install --quiet --assumeyes git gnupg golang
+  SHELL
+  config.vm.provision "file", source: "assets/vagrant/fedora33.test-chezmoi.sh", destination: "test-chezmoi.sh"
+end
diff --git a/assets/vagrant/fedora33.test-chezmoi.sh b/assets/vagrant/fedora33.test-chezmoi.sh
@@ -0,0 +1,5 @@
+#!/bin/sh
+
+go get golang.org/dl/go1.17
+"$HOME"/go/bin/go1.17 download
+( cd /chezmoi && "$HOME"/go/bin/go1.17 test ./... )
diff --git a/assets/vagrant/freebsd13.Vagrantfile b/assets/vagrant/freebsd13.Vagrantfile
@@ -0,0 +1,9 @@
+Vagrant.configure("2") do |config|
+  config.vm.box = "generic/freebsd13"
+  config.vm.hostname = "freebsd13"
+  config.vm.synced_folder ".", "/chezmoi", type: "rsync"
+  config.vm.provision "shell", inline: <<-SHELL
+    pkg install --quiet --yes git gnupg go
+  SHELL
+  config.vm.provision "file", source: "assets/vagrant/freebsd13.test-chezmoi.sh", destination: "test-chezmoi.sh"
+end
diff --git a/assets/vagrant/freebsd13.test-chezmoi.sh b/assets/vagrant/freebsd13.test-chezmoi.sh
@@ -0,0 +1,3 @@
+#!/bin/sh
+
+( cd /chezmoi && go test ./... )
diff --git a/assets/vagrant/openbsd6.Vagrantfile b/assets/vagrant/openbsd6.Vagrantfile
@@ -0,0 +1,9 @@
+Vagrant.configure("2") do |config|
+  config.vm.box = "generic/openbsd6"
+  config.vm.hostname = "openbsd6"
+  config.vm.synced_folder ".", "/chezmoi", type: "rsync"
+  config.vm.provision "shell", inline: <<-SHELL
+    pkg_add -x git gnupg go
+  SHELL
+  config.vm.provision "file", source: "assets/vagrant/openbsd6.test-chezmoi.sh", destination: "test-chezmoi.sh"
+end
diff --git a/assets/vagrant/openbsd6.test-chezmoi.sh b/assets/vagrant/openbsd6.test-chezmoi.sh
@@ -0,0 +1,3 @@
+#!/bin/sh
+
+( cd /chezmoi && go test ./... )
diff --git a/assets/vagrant/test.sh b/assets/vagrant/test.sh
@@ -0,0 +1,15 @@
+#!/bin/sh
+
+for os in "$@"; do
+    if [ -f "${os}.Vagrantfile" ]; then
+        export VAGRANT_VAGRANTFILE=assets/vagrant/${os}.Vagrantfile
+        (
+            cd ../.. &&
+            vagrant up &&
+            vagrant ssh -c "sh test-chezmoi.sh" &&
+            vagrant destroy -f
+        )
+    else
+        echo "${os}.Vagrantfile not found"
+    fi
+done