Skip to content

Commit 59ad7f2

Browse files
committed
Update asset_archive_format description
1 parent c939475 commit 59ad7f2

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ This module can be used to select a release from a Github repository, select an
3737
| Parameter | Type | Description |
3838
|--------------------|------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
3939
|asset_arch_mapping | Type: `dict` |If the repo uses non-standard strings to specify CPU architecture, you can define a custom mapping between those and standard architectures. For example, if some repo uses `64` instead of `x86_64` or `amd64`, you can set this option to `amd64: "64"` or `x86_64: "64"`. |
40-
|asset_archive_format| Type: `str` |If the asset is an archive, you can specify the archive format (one of "zip", "tar", "gztar", "bztar", or "xztar"). If not provided, the module will use the filename extension to guess the format. |
40+
|asset_archive_format| Type: `str` |If the asset is an archive, you can specify the archive format for unpacking. The format should be one of the formats supported by Python's `shutil.unpack_archive()` function: `zip`, `tar`, `gztar`, `bztar`, or `xztar`. If not provided, the module will use the filename extension to guess the format. |
4141
|asset_regex | Type: `str` <br/>**Required** |A regex for selecting an asset (file name) from all the assets of selected release. If there are multiple assets for different OSes and CPU architectures, you don't need to specify OS (darwin, linux, ...) and architecture (x86_64, amd64, aarch64, arm64, ...) in your regex (just write `.*` in place of them). This module tries to narrow down assets based on the system's OS and CPU architecture. |
4242
|move_rules | Type: `list` <br/>**Required** |You need to specify how individual items from an asset should be moved to the system. Privide a list of rules. Each rule should specify `src_regex` and `dst`, and could specify `mode`, `owner`, `group`. An asset can be a single file, or an archive (`.zip`, `.tar.gz`, ...). When asset is an archive, you select by `src_regex` some paths (directories or files) relative to archive root, and they will move to `dst`. Even if the asset is just a single file (not an archive), you should specify a rule to move that file (`src_regex` can be any regex mathing file name, e.g. `.*`).|
4343
|repo | Type: `str` <br/>**Required** |The name of the repository in the format `user_or_org/repo_name`. |

plugins/modules/install_from_github.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,10 @@
5555
5656
asset_archive_format:
5757
description:
58-
- If the asset is an archive, you can specify the archive format
59-
(one of "zip", "tar", "gztar", "bztar", or "xztar").
60-
If not provided, the module will use the filename extension to guess the format.
58+
- "If the asset is an archive, you can specify the archive format for unpacking.
59+
The format should be one of the formats supported by Python's `shutil.unpack_archive()`
60+
function: `zip`, `tar`, `gztar`, `bztar`, or `xztar`.
61+
If not provided, the module will use the filename extension to guess the format."
6162
required: false
6263
type: str
6364

0 commit comments

Comments
 (0)