Panic when fzf was built without version information

So that the package maintainers would immediately know that the build is
incorrect. But is there a way to make build simply fail?

Related: https://github.com/junegunn/fzf.vim/issues/1150

BUILD.md

@@ -17,20 +17,11 @@ make
 # Build fzf binary and copy it to bin directory
 make install
 
-# Build 32-bit and 64-bit executables and tarballs in target
+# Build fzf binaries and archives for all platforms using goreleaser
+make build
+
+# Publish GitHub release
 make release
-
-# Make release archives for all supported platforms in target
-make release-all
-```
-
-### Using `go get`
-
-Alternatively, you can build fzf directly with `go get` command without
-manually cloning the repository.
-
-```sh
-go get -u github.com/junegunn/fzf
 ```
 
 Third-party libraries used

CHANGELOG.md

@@ -29,6 +29,24 @@ CHANGELOG
     ```
 - More `--border` options
   - `vertical`, `top`, `bottom`, `left`, `right`
+  - Updated Vim plugin to use these new `--border` options
+    ```vim
+    " Floating popup window in the center of the screen
+    let g:fzf_layout = { 'window': { 'width': 0.9, 'height': 0.6 } }
+
+    " Popup with 100% width
+    let g:fzf_layout = { 'window': { 'width': 1.0, 'height': 0.5, 'border': 'horizontal' } }
+
+    " Popup with 100% height
+    let g:fzf_layout = { 'window': { 'width': 0.5, 'height': 1.0, 'border': 'vertical' } }
+
+    " Similar to 'down' layout, but it uses a popup window and doesn't affect the window layout
+    let g:fzf_layout = { 'window': { 'width': 1.0, 'height': 0.5, 'yoffset': 1.0, 'border': 'top' } }
+
+    " Opens on the right;
+    "   'highlight' option is still supported but it will only take the foreground color of the group
+    let g:fzf_layout = { 'window': { 'width': 0.5, 'height': 1.0, 'xoffset': 1.0, 'border': 'left', 'highlight': 'Comment' } }
+    ```
 - To indicate if `--multi` mode is enabled, fzf will print the number of
   selected items even when no item is selected
   ```sh
@@ -39,6 +57,7 @@ CHANGELOG
   seq 100 | fzf --multi 5
     # 100/100 (0/5)
   ```
+- Since 0.24.0, release binaries will be uploaded to https://github.com/junegunn/fzf/releases
 
 0.23.1
 ------

Makefile

@@ -6,6 +6,8 @@ ROOT_DIR       := $(shell dirname $(MAKEFILE))
 SOURCES        := $(wildcard *.go src/*.go src/*/*.go) $(MAKEFILE)
 
 VERSION        := $(shell git describe --abbrev=0)
+VERSION_TRIM   := $(shell sed "s/-.*//" <<< $(VERSION))
+VERSION_REGEX  := $(subst .,\.,$(VERSION_TRIM))
 REVISION       := $(shell git log -n 1 --pretty=format:%h -- $(SOURCES))
 BUILD_FLAGS    := -a -ldflags "-X main.version=$(VERSION) -X main.revision=$(REVISION) -w '-extldflags=$(LDFLAGS)'" -tags "$(TAGS)"
 
@@ -15,7 +17,6 @@ BINARYARM6     := fzf-$(GOOS)_arm6
 BINARYARM7     := fzf-$(GOOS)_arm7
 BINARYARM8     := fzf-$(GOOS)_arm8
 BINARYPPC64LE  := fzf-$(GOOS)_ppc64le
-VERSION        := $(shell awk -F= '/version =/ {print $$2}' src/constants.go | tr -d "\" ")
 
 # https://en.wikipedia.org/wiki/Uname
 UNAME_M := $(shell uname -m)
@@ -36,7 +37,7 @@ else ifeq ($(UNAME_M),aarch64)
 else ifeq ($(UNAME_M),ppc64le)
 	BINARY := $(BINARYPPC64LE)
 else
-$(error "Build on $(UNAME_M) is not supported, yet.")
+$(error Build on $(UNAME_M) is not supported, yet.)
 endif
 
 all: target/$(BINARY)
@@ -50,9 +51,44 @@ test: $(SOURCES)
 
 install: bin/fzf
 
-release:
+build:
 	goreleaser --rm-dist --snapshot
 
+release:
+ifndef GITHUB_TOKEN
+	$(error GITHUB_TOKEN is not defined)
+endif
+
+	# Check if we are on master branch
+ifneq ($(shell git symbolic-ref --short HEAD),master)
+	$(error Not on master branch)
+endif
+
+	# Check if version numbers are properly updated
+	grep -q ^$(VERSION_REGEX)$$ CHANGELOG.md
+	grep -qF '"fzf $(VERSION_TRIM)"' man/man1/fzf.1
+	grep -qF '"fzf $(VERSION_TRIM)"' man/man1/fzf-tmux.1
+	grep -qF $(VERSION) install
+	grep -qF $(VERSION) install.ps1
+
+	# Make release note out of CHANGELOG.md
+	sed -n '/^$(VERSION_REGEX)$$/,/^[0-9]/p' CHANGELOG.md | tail -r | \
+		sed '1,/^ *$$/d' | tail -r | sed 1,2d | tee tmp/release-note
+
+	# Push to temp branch first so that install scripts always works on master branch
+	git checkout -B temp master
+	git push origin temp --follow-tags --force
+
+	# Make a GitHub release
+	goreleaser --rm-dist --release-notes tmp/release-note
+
+	# Push to master
+	git checkout master
+	git push origin master
+
+	# Delete temp branch
+	git push origin --delete temp
+
 clean:
 	$(RM) -r dist target
 
@@ -90,4 +126,4 @@ update:
 	$(GO) get -u
 	$(GO) mod tidy
 
-.PHONY: all release test install clean docker docker-test update
+.PHONY: all build release test install clean docker docker-test update

README-VIM.md

@@ -298,7 +298,6 @@ following options are allowed:
 - Optional:
     - `yoffset` [float default 0.5 range [0 ~ 1]]
     - `xoffset` [float default 0.5 range [0 ~ 1]]
-    - `highlight` [string default `'Comment'`]: Highlight group for border
     - `border` [string default `rounded`]: Border style
         - `rounded` / `sharp` / `horizontal` / `vertical` / `top` / `bottom` / `left` / `right` / `none`
 

install

@@ -2,7 +2,7 @@
 
 set -u
 
-version=0.24.0-rc1
+version=0.24.0
 auto_completion=
 key_bindings=
 update_config=2

install.ps1

@@ -1,4 +1,4 @@
-$version="0.24.0-rc1"
+$version="0.24.0"
 
 $fzf_base=Split-Path -Parent $MyInvocation.MyCommand.Definition
 

main.go

@@ -9,6 +9,9 @@ var version string
 var revision string
 
 func main() {
+	if len(version) == 0 {
+		panic("Invalid build: version information missing")
+	}
 	protector.Protect()
 	fzf.Run(fzf.ParseOptions(), version, revision)
 }

plugin/fzf.vim

@@ -128,7 +128,7 @@ endfunction
 
 function! s:default_layout()
   return s:popup_support()
-        \ ? { 'window' : { 'width': 0.9, 'height': 0.6, 'highlight': 'Normal' } }
+        \ ? { 'window' : { 'width': 0.9, 'height': 0.6 } }
         \ : { 'down': '~40%' }
 endfunction
 
@@ -437,7 +437,7 @@ try
       let prefix = '( '.source.' )|'
     elseif type == 3
       let temps.input = s:fzf_tempname()
-      call writefile(map(source, '<SID>enc_to_cp(v:val)'), temps.input)
+      call writefile(source, temps.input)
       let prefix = (s:is_win ? 'type ' : 'cat ').fzf#shellescape(temps.input).'|'
     else
       throw 'Invalid source type'

src/terminal.go

@@ -1855,13 +1855,9 @@ func (t *Terminal) Loop() {
 					reader := bufio.NewReader(out)
 					eofChan := make(chan bool)
 					finishChan := make(chan bool, 1)
-					reapChan := make(chan bool)
 					err := cmd.Start()
-					reaps := 0
+					if err == nil {
-					if err != nil {
+						reapChan := make(chan bool)
-						t.reqBox.Set(reqPreviewDisplay, previewResult{version, []string{err.Error()}, 0, ""})
-					} else {
-						reaps = 2
 						lineChan := make(chan eachLine)
 						// Goroutine 1 reads process output
 						go func() {
@@ -1874,6 +1870,7 @@ func (t *Terminal) Loop() {
 							}
 							eofChan <- true
 						}()
+
 						// Goroutine 2 periodically requests rendering
 						go func(version int64) {
 							lines := []string{}
@@ -1915,42 +1912,47 @@ func (t *Terminal) Loop() {
 							ticker.Stop()
 							reapChan <- true
 						}(version)
-					}
+
-					// Goroutine 3 is responsible for cancelling running preview command
+						// Goroutine 3 is responsible for cancelling running preview command
-					go func(version int64) {
+						go func(version int64) {
-						timer := time.NewTimer(previewDelayed)
+							timer := time.NewTimer(previewDelayed)
-					Loop:
+						Loop:
-						for {
+							for {
-							select {
+								select {
-							case <-timer.C:
+								case <-timer.C:
-								t.reqBox.Set(reqPreviewDelayed, version)
+									t.reqBox.Set(reqPreviewDelayed, version)
-							case code := <-t.killChan:
+								case code := <-t.killChan:
-								if code != exitCancel {
+									if code != exitCancel {
-									util.KillCommand(cmd)
-									os.Exit(code)
-								} else {
-									timer := time.NewTimer(previewCancelWait)
-									select {
-									case <-timer.C:
 										util.KillCommand(cmd)
-									case <-finishChan:
+										os.Exit(code)
+									} else {
+										timer := time.NewTimer(previewCancelWait)
+										select {
+										case <-timer.C:
+											util.KillCommand(cmd)
+										case <-finishChan:
+										}
+										timer.Stop()
 									}
-									timer.Stop()
+									break Loop
+								case <-finishChan:
+									break Loop
 								}
-								break Loop
-							case <-finishChan:
-								break Loop
 							}
-						}
+							timer.Stop()
-						timer.Stop()
+							reapChan <- true
-						reapChan <- true
+						}(version)
-					}(version)
+
-					<-eofChan
+						<-eofChan          // Goroutine 1 finished
-					cmd.Wait() // NOTE: We should not call Wait before EOF
+						cmd.Wait()         // NOTE: We should not call Wait before EOF
-					finishChan <- true
+						finishChan <- true // Tell Goroutine 3 to stop
-					for i := 0; i < reaps; i++ {
+						<-reapChan         // Goroutine 2 and 3 finished
 						<-reapChan
+					} else {
+						// Failed to start the command. Report the error immediately.
+						t.reqBox.Set(reqPreviewDisplay, previewResult{version, []string{err.Error()}, 0, ""})
 					}
+
 					cleanTemporaryFiles()
 				} else {
 					t.reqBox.Set(reqPreviewDisplay, previewResult{version, nil, 0, ""})