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

[enh] add xz decompression for sources #1785

Open
wants to merge 5 commits into
base: dev
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
add documentation for gz/bz2/xz
  • Loading branch information
emmanuel-averty committed Mar 13, 2024
commit 10e79999fc89da11d1c898e012f07e7570e9497f
6 changes: 5 additions & 1 deletion helpers/utils
Original file line number Diff line number Diff line change
Expand Up @@ -97,18 +97,22 @@ fi
# ```text
# format = "tar.gz"/xz/bz2 # automatically guessed from the extension of the URL, but can be set explicitly. Will use `tar` to extract
# "zip" # automatically guessed from the extension of the URL, but can be set explicitly. Will use `unzip` to extract
# "gz" # automatically guessed from the extension of the URL, but can be set explicitly. Will use `gunzip` to extract
# "bz2" # automatically guessed from the extension of the URL, but can be set explicitly. Will use `bunzip2` to extract
# "xz" # automatically guessed from the extension of the URL, but can be set explicitly. Will use `xz -d` to extract
# "docker" # useful to extract files from an already-built docker image (instead of rebuilding them locally). Will use `docker-image-extract` to extract
# "whatever" # an arbitrary value, not really meaningful except to imply that the file won't be extracted
#
# in_subdir = true # default, there's an intermediate subdir in the archive before accessing the actual files
# false # sources are directly in the archive root
# n # (special cases) an integer representing a number of subdirs levels to get rid of
#
# extract = true # default if file is indeed an archive such as .zip, .tar.gz, .tar.bz2, ...
# extract = true # default if file is indeed an archive such as .zip, .tar.gz, .tar.bz2, gz, ...
# = false # default if file 'format' is not set and the file is not to be extracted because it is not an archive but a script or binary or whatever asset.
# # in which case the file will only be `mv`ed to the location possibly renamed using the `rename` value
#
# rename = "whatever_your_want" # to be used for convenience when `extract` is false and the default name of the file is not practical
# # also used for single file archives (gz, bz2, xz) to rename the extracted file (default : the source id, or the app name for main source)
# platform = "linux/amd64" # (defaults to "linux/$YNH_ARCH") to be used in conjonction with `format = "docker"` to specify which architecture to extract for
# ```
#
Expand Down