Difference between revisions of "Autobuild installables"
Jump to navigation
Jump to search
m (→Example) |
(Add private package instructions) |
||
| Line 5: | Line 5: | ||
Specify installables as dependencies of the current pacakge for use by the <code>autobuild install</code> command. | Specify installables as dependencies of the current pacakge for use by the <code>autobuild install</code> command. | ||
Arguments: | '''Arguments:''' | ||
*''command'': installable command: add, remove, edit, or print. | *''command'': installable command: add, remove, edit, or print. | ||
*''name'': the name of the installable. | *''name'': the name of the installable. | ||
*''argument'': a key=value pair specifying an attribute. | *''argument'': a key=value pair specifying an attribute (See below) | ||
'''Attributes:''' | |||
*''creds'' - Optional credentials method for private packages. Valid values: github, gitlab | |||
*''url'' - Download URL | |||
*''hash'' - File hash | |||
*''hash_algorithm'' - File digest algorithm. Valid values: md5, blake2b | |||
'''Private Packages''': | |||
As of [https://github.com/secondlife/autobuild/releases/tag/v3.5.0 autobuild v3.5.0] autobuild supports downloading | |||
packages from private GitHub and GitLab repositories. In order to use this functionality, a package must be marked with | |||
the a 'creds' value such as <code>creds=github</code>. | |||
Environment variables are used to provide credentials to autobuild during [[Autobuild install|package download]]: | |||
* <code>AUTOBUILD_GITHUB_TOKEN</code> | |||
* <code>AUTOBUILD_GITLAB_TOKEN</code> | |||
}} | }} | ||
Latest revision as of 10:43, 29 September 2022
autobuild installables
option [value] [option [value]] ...
[command] [name] [argument [argument ...]]
option [value] [option [value]] ...
[command] [name] [argument [argument ...]]
Specify installables as dependencies of the current pacakge for use by the autobuild install command.
Arguments:
- command: installable command: add, remove, edit, or print.
- name: the name of the installable.
- argument: a key=value pair specifying an attribute (See below)
Attributes:
- creds - Optional credentials method for private packages. Valid values: github, gitlab
- url - Download URL
- hash - File hash
- hash_algorithm - File digest algorithm. Valid values: md5, blake2b
Private Packages:
As of autobuild v3.5.0 autobuild supports downloading
packages from private GitHub and GitLab repositories. In order to use this functionality, a package must be marked with
the a 'creds' value such as creds=github.
Environment variables are used to provide credentials to autobuild during package download:
AUTOBUILD_GITHUB_TOKENAUTOBUILD_GITLAB_TOKEN
Standard Options
| Option | Shortcut | Value | Description |
|---|---|---|---|
| --debug | -d | None | Display debug output |
| --dry-run | -n | None | Run tool in dry run mode if available |
| --help | -h | None | Show help message |
| --quiet | -q | None | Display minimal output |
| --verbose | -v | None | Display verbose output |
Command-Specific Options
| Option | Shortcut | Value | Description |
|---|---|---|---|
| --config-file config_file | N/A | Path of configuration file | Use specified configuration file. (defaults to $AUTOBUILD_CONFIG_FILE or "autobuild.xml") |
| --archive archive | -a archive | Archive name | Infer installable attributes from the given archive |
Example
autobuild installables edit otherpkg url=<url>