fzf icon indicating copy to clipboard operation
fzf copied to clipboard

Include manual in a release asset

Open kit494way opened this issue 11 months ago • 3 comments

Checklist

  • [x] I have read through the manual page (man fzf)
  • [x] I have searched through the existing issues
  • [ ] For bug reports, I have checked if the bug is reproducible in the latest version of fzf

Output of fzf --version

0.59.0 (bbe1721)

OS

  • [x] Linux
  • [ ] macOS
  • [ ] Windows
  • [ ] Etc.

Shell

  • [ ] bash
  • [ ] zsh
  • [x] fish

Problem / Steps to reproduce

When I download a release asset, I need to download a manual file separately. It would be helpful if the manual was included in a release asset.

kit494way avatar Feb 08 '25 08:02 kit494way

FYI, the manual is embedded in the fzf binary, and you can open it with fzf --man.

junegunn avatar Feb 08 '25 09:02 junegunn

Thanks. But I prefer to display the manual in the same way as any other manual (i.e. man fzf).

kit494way avatar Feb 08 '25 11:02 kit494way

I figured. Adding the file to the archives is trivial.

diff --git a/.goreleaser.yml b/.goreleaser.yml
index b613159..863afce 100644
--- a/.goreleaser.yml
+++ b/.goreleaser.yml
@@ -84,7 +84,9 @@ archives:
       - goos: windows
         format: zip
     files:
-      - non-existent*
+      - LICENSE
+      - src: man/man1/fzf.1
+        strip_parent: true
 
 release:
   github:

But we would also have to update the install scripts.

  • https://github.com/junegunn/fzf/blob/master/install
  • https://github.com/junegunn/fzf/blob/master/install.ps1

junegunn avatar Feb 08 '25 13:02 junegunn