Difference between revisions of "Autobuild installables"

From Second Life Wiki
Jump to navigation Jump to search
(Created page with "<!-- ======================================================================= This wiki page was generated by the converting the --help output from this command using the pyhelp2w…")
 
(Add private package instructions)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<!-- =======================================================================
{{Autobuild Cmd
This wiki page was generated by the converting the --help output from this
|command=
command using the pyhelp2wiki command.
autobuild installables  <br>    ''option'' [''value''] [''option'' [''value'']] ... <br>    [''command''] [''name''] [''argument'' [''argument'' ...]]
|comments=
Specify installables as dependencies of the current pacakge for use by the <code>autobuild install</code> command.


Rather than changing this page directly, or at least after having done so,
'''Arguments:'''
consider making the change to the command help itself (or suggest doing so
to the author).
======================================================================== -->
Usage:
      <nowiki>autobuild installables [-h] [--config-file CONFIG_FILE] [-a ARCHIVE]</nowiki>
                              <nowiki>[-i] [-n] [-q] [-v] [-d]</nowiki>
                              <nowiki>[command] [name] [argument [argument ...]]</nowiki>


*''command'': installable command: add, remove, edit, or print.
*''name'': the name of the installable.
*''argument'': a key=value pair specifying an attribute (See below)


Arguments:
'''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


:;<nowiki>command</nowiki>
'''Private Packages''':
::<nowiki>installable command: add, remove, edit, or print</nowiki>
:;<nowiki>name</nowiki>
::<nowiki>the name of the installable</nowiki>
:;<nowiki>argument</nowiki>
::<nowiki>a key=value pair specifying an attribute </nowiki>


Options:
As of [https://github.com/secondlife/autobuild/releases/tag/v3.5.0 autobuild v3.5.0] autobuild supports downloading
:{|border="0" cellpadding="5" style="border-collapse: collapse; border-style: none;"
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>.


|- style="vertical-align: top;"
Environment variables are used to provide credentials to autobuild during [[Autobuild install|package download]]:
|<nowiki>-h, --help</nowiki>
|<nowiki>show this help message and exit</nowiki>


|- style="vertical-align: top;"
* <code>AUTOBUILD_GITHUB_TOKEN</code>
|<nowiki>--config-file&nbsp;CONFIG_FILE</nowiki>
* <code>AUTOBUILD_GITLAB_TOKEN</code>
| <nowiki>(defaults to $AUTOBUILD_CONFIG_FILE or "autobuild.xml")</nowiki>
}}


|- style="vertical-align: top;"
'''Command-Specific Options'''
|<nowiki>-a&nbsp;ARCHIVE, --archive&nbsp;ARCHIVE</nowiki>
{| class=lltable border=1
| <nowiki>infer installable attributes from the given archive</nowiki>
|--
!width=150| Option
! Shortcut
!Value
!Description


|- style="vertical-align: top;"
|-  
|<nowiki>-i, --interactive</nowiki>
| --config-file ''config_file''
|<nowiki>run as an interactive session</nowiki>
|N/A
| Path of configuration file
| Use specified configuration file. (defaults to $AUTOBUILD_CONFIG_FILE or "autobuild.xml")


|- style="vertical-align: top;"
|-  
|<nowiki>-n, --dry-run</nowiki>
| --archive ''archive''
|<nowiki>run tool in dry run mode if available</nowiki>
| -a ''archive''
 
| Archive name
|- style="vertical-align: top;"
| Infer installable attributes from the given archive
|<nowiki>-q, --quiet</nowiki>
|<nowiki>minimal output</nowiki>
 
|- style="vertical-align: top;"
|<nowiki>-v, --verbose</nowiki>
|<nowiki>verbose output</nowiki>
 
|- style="vertical-align: top;"
|<nowiki>-d, --debug</nowiki>
|<nowiki>debug output </nowiki>


|}
|}
<nowiki>EXAMPLE: autobuild edit indra_common platform=linux hash=<md5 hash> url=<url></nowiki>


[[Category:Autobuild]]
== Example ==
autobuild installables edit otherpkg url=<url>

Latest revision as of 10:43, 29 September 2022

autobuild installables
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_TOKEN
  • AUTOBUILD_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>
Retrieved from "https://wiki.secondlife.com/w/index.php?title=Autobuild_installables&oldid=1212493"