Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include manual in a release asset #4229

Open
4 of 10 tasks
kit494way opened this issue Feb 8, 2025 · 3 comments
Open
4 of 10 tasks

Include manual in a release asset #4229

kit494way opened this issue Feb 8, 2025 · 3 comments

Comments

@kit494way
Copy link

Checklist

  • I have read through the manual page (man fzf)
  • 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

  • Linux
  • macOS
  • Windows
  • Etc.

Shell

  • bash
  • zsh
  • 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.

@junegunn
Copy link
Owner

junegunn commented Feb 8, 2025

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

@kit494way
Copy link
Author

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

@junegunn
Copy link
Owner

junegunn commented Feb 8, 2025

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants