Difference between revisions of "Autobuild Shell Functions"
Nat Linden (talk | contribs) (add back the rest of the warning without <p/>) |
Nat Linden (talk | contribs) (Apparently there's a maximum length to warning text? Extracted install suggestions to after warning.) |
||
| Line 1: | Line 1: | ||
{{Autobuild Nav}} | {{Autobuild Nav}} | ||
{{Warning|This page describes autobuild 1.0. As of 2015-03-20, autobuild 1.0 can be found in [https://bitbucket.org/lindenlab/autobuild-1.0/ this repository]; as of this date, [https://bitbucket.org/lindenlab/autobuild/ the official repository] and [https://pypi.python.org/pypi/autobuild the PyPI package] are still at autobuild 0.8. | {{Warning|This page describes autobuild 1.0. As of 2015-03-20, autobuild 1.0 can be found in [https://bitbucket.org/lindenlab/autobuild-1.0/ this repository]; as of this date, [https://bitbucket.org/lindenlab/autobuild/ the official repository] and [https://pypi.python.org/pypi/autobuild the PyPI package] are still at autobuild 0.8.}} | ||
You can install autobuild 1.0 (e.g. into a [http://docs.python-guide.org/en/latest/dev/virtualenvs/ virtualenv]) from the alternate repository using a command such as (bash): | |||
pip install 'hg+http://bitbucket.org/lindenlab/autobuild-1.0#egg=autobuild' | |||
or (Windows command prompt): | |||
pip install hg+http://bitbucket.org/lindenlab/autobuild-1.0#egg=autobuild | |||
Autobuild offers a set of shell functions for use in <code>build-cmd.sh</code> scripts which can be added to the environment by inserting the following line into any build script: | Autobuild offers a set of shell functions for use in <code>build-cmd.sh</code> scripts which can be added to the environment by inserting the following line into any build script: | ||
Revision as of 12:45, 20 March 2015
This page describes autobuild 1.0. As of 2015-03-20, autobuild 1.0 can be found in this repository; as of this date, the official repository and the PyPI package are still at autobuild 0.8.
You can install autobuild 1.0 (e.g. into a virtualenv) from the alternate repository using a command such as (bash):
pip install 'hg+http://bitbucket.org/lindenlab/autobuild-1.0#egg=autobuild'
or (Windows command prompt):
pip install hg+http://bitbucket.org/lindenlab/autobuild-1.0#egg=autobuild
Autobuild offers a set of shell functions for use in build-cmd.sh scripts which can be added to the environment by inserting the following line into any build script:
eval "$("$AUTOBUILD" source_environment)"
The exact shell code that is injected into your environment upon execution of this command is here, with (for Windows) additional functions here.
General functions
Shell functions provided by autobuild:
| Function | Description |
|---|---|
| pass | Indicates build has succeeded |
| fail $comment | Indicates build has failed, citing $comment in the output |
| fetch_archive $url $archive $md5 | Uses curl to download $archive from the $url and checks the downloaded file hash against the $md5 provided. |
| extract $file | Extracts contents of an archive appropriate for the tar extension of $file. |
| calc_md5 $file | Calculate the md5 of $file |
Windows-only commands
Windows-only shell commands (Cygwin):
| Function | Description |
|---|---|
| build_vcproj $vcproj $config | Launches a Visual Studio build of $vcproj, building configuration $config.
If $USE_INCREDIBUILD is set, the same build is launched via BuildConsole, Incredibuild's command-line launcher. |
| build_sln $sln $config $project | Launches a Visual Studio build using the solution file $sln, configuration $config, and specifying project $project.
If $project is omitted, then the entire solution will be built. |
| load_vsvars | Import Visual Studio paths, includes and libs into the shell environment |