Spec generated from JSON schema
Contents
Spec generated from JSON schema#
This represents the spec that is used to validate recipes against.
BoaRecipeV1#
type |
object |
||||
properties |
|||||
|
Context |
||||
The recipe context. |
|||||
type |
object |
||||
|
Package |
||||
The package name and version. |
|||||
allOf |
:ref: |
||||
|
Source |
||||
The source items to be downloaded and used for the build. |
|||||
type |
array |
||||
items |
anyOf |
:ref: |
|||
:ref: |
|||||
:ref: |
|||||
:ref: |
|||||
:ref: |
|||||
|
:ref: |
||||
|
Features |
||||
type |
array |
||||
items |
|||||
|
Steps |
||||
type |
array |
||||
items |
:ref: |
||||
|
:ref: |
||||
|
Extra |
||||
type |
object |
||||
additionalProperties |
False |
||||
definitions |
|||||
|
Package |
||||
type |
object |
||||
properties |
|||||
|
Name |
||||
The package name |
|||||
type |
string |
||||
|
Version |
||||
The package version |
|||||
type |
string |
||||
additionalProperties |
False |
||||
|
UrlSource |
||||
type |
object |
||||
properties |
|||||
|
Patches |
||||
type |
array |
||||
items |
type |
string |
|||
|
Folder |
||||
type |
string |
||||
|
Url |
||||
type |
string |
||||
|
Sha256 |
||||
type |
string |
||||
maxLength |
64 |
||||
minLength |
64 |
||||
pattern |
^[0-9a-fA-F]{64}$ |
||||
|
Md5 |
||||
type |
string |
||||
maxLength |
32 |
||||
minLength |
32 |
||||
pattern |
^[0-9a-fA-F]{32}$ |
||||
|
Sha1 |
||||
type |
string |
||||
maxLength |
40 |
||||
minLength |
40 |
||||
pattern |
^[0-9a-fA-F]{40}$ |
||||
|
Fn |
||||
type |
string |
||||
additionalProperties |
False |
||||
|
GitSource |
||||
type |
object |
||||
properties |
|||||
|
Patches |
||||
type |
array |
||||
items |
type |
string |
|||
|
Folder |
||||
type |
string |
||||
|
Git Rev |
||||
type |
string |
||||
default |
HEAD |
||||
|
Git Url |
||||
type |
string |
||||
|
Git Depth |
||||
type |
integer |
||||
default |
-1 |
||||
additionalProperties |
False |
||||
|
HgSource |
||||
type |
object |
||||
properties |
|||||
|
Patches |
||||
type |
array |
||||
items |
type |
string |
|||
|
Folder |
||||
type |
string |
||||
|
Hg Url |
||||
type |
string |
||||
|
Hg Tag |
||||
type |
string |
||||
default |
tip |
||||
additionalProperties |
False |
||||
|
SvnSource |
||||
type |
object |
||||
properties |
|||||
|
Patches |
||||
type |
array |
||||
items |
type |
string |
|||
|
Folder |
||||
type |
string |
||||
|
Svn Url |
||||
type |
string |
||||
|
Svn Rev |
||||
type |
string |
||||
default |
head |
||||
|
Svn Ignore Externals |
||||
type |
boolean |
||||
default |
False |
||||
additionalProperties |
False |
||||
|
LocalSource |
||||
type |
object |
||||
properties |
|||||
|
Patches |
||||
type |
array |
||||
items |
type |
string |
|||
|
Folder |
||||
type |
string |
||||
|
Path |
||||
type |
string |
||||
additionalProperties |
False |
||||
|
NoarchType |
||||
An enumeration. |
|||||
enum |
generic, python |
||||
|
RunExports |
||||
type |
object |
||||
properties |
|||||
|
Weak |
||||
Weak run exports apply from the host env to the run env |
|||||
type |
array |
||||
items |
type |
string |
|||
|
Strong |
||||
Strong run exports apply from the build and host env to the run env |
|||||
type |
array |
||||
items |
type |
string |
|||
|
Noarch |
||||
Noarch run exports are the only ones looked at when building noarch packages |
|||||
type |
array |
||||
items |
type |
string |
|||
|
Weak Constrains |
||||
Weak run constrains add run_constrains from the host env |
|||||
type |
array |
||||
items |
type |
string |
|||
|
Strong Constrains |
||||
Strong run constrains add run_constrains from the build and host env |
|||||
type |
array |
||||
items |
type |
string |
|||
additionalProperties |
False |
||||
|
Build |
||||
type |
object |
||||
properties |
|||||
|
Number |
||||
Build number to version current build in addition to package version |
|||||
type |
integer |
||||
minimum |
0 |
||||
default |
0 |
||||
|
String |
||||
Build string to identify build variant (if not explicitly set, computed automatically from used build variant) |
|||||
type |
string |
||||
|
Skip |
||||
List of conditions under which to skip the build of the package. |
|||||
type |
array |
||||
items |
type |
string |
|||
|
Script |
||||
Build script to be used. If not given, tries to find ‘build.sh’ on Unix or ‘bld.bat’ on Windows inside the recipe folder. |
|||||
anyOf |
type |
string |
|||
type |
array |
||||
items |
type |
string |
|||
|
Can be either ‘generic’ or ‘python’. A noarch ‘python’ package compiles .pyc files upon installation. |
||||
allOf |
:ref: |
||||
|
Entry Points |
||||
type |
array |
||||
items |
type |
string |
|||
|
Run Exports |
||||
anyOf |
:ref: |
||||
type |
array |
||||
items |
type |
string |
|||
|
Ignore Run Exports |
||||
type |
array |
||||
items |
type |
string |
|||
|
Ignore Run Exports From |
||||
type |
array |
||||
items |
type |
string |
|||
|
Track Features |
||||
type |
array |
||||
items |
type |
string |
|||
|
Include Recipe |
||||
Include recipe in final package. |
|||||
type |
boolean |
||||
default |
True |
||||
|
Pre-Link |
||||
Script to execute when installing - before linking. Highly discouraged! |
|||||
type |
string |
||||
|
Post-Link |
||||
Script to execute when installing - after linking. |
|||||
type |
string |
||||
|
Pre-Unlink |
||||
Script to execute when removing - before unlinking. |
|||||
type |
string |
||||
|
Osx Is App |
||||
type |
boolean |
||||
default |
False |
||||
|
Disable Pip |
||||
type |
boolean |
||||
default |
False |
||||
|
Preserve Egg Dir |
||||
type |
boolean |
||||
default |
False |
||||
|
No Link |
||||
type |
array |
||||
items |
type |
string |
|||
pattern |
^[^\]+$ |
||||
|
Binary Relocation |
||||
default |
True |
||||
anyOf |
type |
boolean |
|||
type |
array |
||||
items |
type |
string |
|||
pattern |
^[^\]+$ |
||||
|
Has Prefix Files |
||||
type |
array |
||||
default |
|||||
items |
type |
string |
|||
pattern |
^[^\]+$ |
||||
|
Binary Has Prefix Files |
||||
type |
array |
||||
items |
type |
string |
|||
pattern |
^[^\]+$ |
||||
|
Ignore Prefix Files |
||||
default |
False |
||||
anyOf |
type |
boolean |
|||
type |
array |
||||
items |
type |
string |
|||
pattern |
^[^\]+$ |
||||
|
Detect Binary Files With Prefix |
||||
type |
boolean |
||||
|
Skip Compile Pyc |
||||
type |
array |
||||
items |
type |
string |
|||
|
Rpaths |
||||
type |
array |
||||
items |
type |
string |
|||
|
Rpaths Patcher |
||||
type |
string |
||||
|
Script Env |
||||
type |
object |
||||
additionalProperties |
type |
string |
|||
|
Always Include Files |
||||
type |
array |
||||
items |
type |
string |
|||
|
Force Use Keys |
||||
type |
array |
||||
items |
type |
string |
|||
|
Force Ignore Keys |
||||
type |
array |
||||
items |
type |
string |
|||
|
Merge Build Host |
||||
type |
boolean |
||||
default |
False |
||||
|
Missing Dso Whitelist |
||||
type |
array |
||||
items |
type |
string |
|||
|
Error Overdepending |
||||
Error on overdepending |
|||||
type |
boolean |
||||
default |
False |
||||
|
Error Overlinking |
||||
Error on overlinking |
|||||
type |
boolean |
||||
default |
False |
||||
additionalProperties |
False |
||||
|
Requirements |
||||
type |
object |
||||
properties |
|||||
|
Build |
||||
type |
array |
||||
items |
type |
string |
|||
|
Host |
||||
type |
array |
||||
items |
type |
string |
|||
|
Run |
||||
type |
array |
||||
items |
type |
string |
|||
|
Run Constrained |
||||
type |
array |
||||
items |
type |
string |
|||
|
Test |
||||
type |
object |
||||
properties |
|||||
|
Files |
||||
Test files that are copied from the recipe into the temporary test directory and are needed during testing. |
|||||
type |
array |
||||
items |
type |
string |
|||
|
Source Files |
||||
Test files that are copied from the source work directory into the temporary test directory and are needed during testing. |
|||||
type |
array |
||||
items |
type |
string |
|||
|
Requires |
||||
In addition to the runtime requirements, you can specify requirements needed during testing. |
|||||
type |
array |
||||
items |
type |
string |
|||
|
Imports |
||||
Test importing modules. |
|||||
type |
array |
||||
items |
type |
string |
|||
|
Commands |
||||
The test commands to execute. |
|||||
type |
array |
||||
items |
type |
string |
|||
|
Output |
||||
type |
object |
||||
properties |
|||||
|
Package |
||||
The package name and version |
|||||
allOf |
:ref: |
||||
|
:ref: |
||||
|
:ref: |
||||
|
:ref: |
||||
|
About |
||||
type |
object |
||||
properties |
|||||
|
Home |
||||
type |
string |
||||
|
Dev Url |
||||
type |
string |
||||
|
Doc Url |
||||
type |
string |
||||
|
Doc Source Url |
||||
type |
string |
||||
|
License Url |
||||
type |
string |
||||
|
License |
||||
type |
string |
||||
|
Summary |
||||
type |
string |
||||
|
Description |
||||
type |
string |
||||
|
License Family |
||||
type |
string |
||||
|
Identifiers |
||||
type |
array |
||||
items |
type |
string |
|||
|
Tags |
||||
type |
array |
||||
items |
type |
string |
|||
|
Keywords |
||||
type |
array |
||||
items |
type |
string |
|||
|
License File |
||||
type |
string |
||||
|
Prelink Message |
||||
type |
string |
||||
|
Readme |
||||
type |
string |