Spec generated from JSON schema#

This represents the spec that is used to validate recipes against.

BoaRecipeV1#

type

object

properties

  • context

Context

The recipe context.

type

object

  • package

Package

The package name and version.

allOf

:ref:#/definitions/Package

  • source

Source

The source items to be downloaded and used for the build.

type

array

items

anyOf

:ref:#/definitions/UrlSource

:ref:#/definitions/GitSource

:ref:#/definitions/HgSource

:ref:#/definitions/SvnSource

:ref:#/definitions/LocalSource

  • build

:ref:#/definitions/Build

  • features

Features

type

array

items

  • steps

Steps

type

array

items

:ref:#/definitions/Output

  • about

:ref:#/definitions/About

  • extra

Extra

type

object

additionalProperties

False

definitions

  • Package

Package

type

object

properties

  • name

Name

The package name

type

string

  • version

Version

The package version

type

string

additionalProperties

False

  • UrlSource

UrlSource

type

object

properties

  • patches

Patches

type

array

items

type

string

  • folder

Folder

type

string

  • url

Url

type

string

  • sha256

Sha256

type

string

maxLength

64

minLength

64

pattern

^[0-9a-fA-F]{64}$

  • md5

Md5

type

string

maxLength

32

minLength

32

pattern

^[0-9a-fA-F]{32}$

  • sha1

Sha1

type

string

maxLength

40

minLength

40

pattern

^[0-9a-fA-F]{40}$

  • fn

Fn

type

string

additionalProperties

False

  • GitSource

GitSource

type

object

properties

  • patches

Patches

type

array

items

type

string

  • folder

Folder

type

string

  • git_rev

Git Rev

type

string

default

HEAD

  • git_url

Git Url

type

string

  • git_depth

Git Depth

type

integer

default

-1

additionalProperties

False

  • HgSource

HgSource

type

object

properties

  • patches

Patches

type

array

items

type

string

  • folder

Folder

type

string

  • hg_url

Hg Url

type

string

  • hg_tag

Hg Tag

type

string

default

tip

additionalProperties

False

  • SvnSource

SvnSource

type

object

properties

  • patches

Patches

type

array

items

type

string

  • folder

Folder

type

string

  • svn_url

Svn Url

type

string

  • svn_rev

Svn Rev

type

string

default

head

  • svn_ignore_externals

Svn Ignore Externals

type

boolean

default

False

additionalProperties

False

  • LocalSource

LocalSource

type

object

properties

  • patches

Patches

type

array

items

type

string

  • folder

Folder

type

string

  • path

Path

type

string

additionalProperties

False

  • NoarchType

NoarchType

An enumeration.

enum

generic, python

  • RunExports

RunExports

type

object

properties

  • weak

Weak

Weak run exports apply from the host env to the run env

type

array

items

type

string

  • strong

Strong

Strong run exports apply from the build and host env to the run env

type

array

items

type

string

  • noarch

Noarch

Noarch run exports are the only ones looked at when building noarch packages

type

array

items

type

string

  • weak_constrains

Weak Constrains

Weak run constrains add run_constrains from the host env

type

array

items

type

string

  • strong_constrains

Strong Constrains

Strong run constrains add run_constrains from the build and host env

type

array

items

type

string

additionalProperties

False

  • Build

Build

type

object

properties

  • number

Number

Build number to version current build in addition to package version

type

integer

minimum

0

default

0

  • string

String

Build string to identify build variant (if not explicitly set, computed automatically from used build variant)

type

string

  • skip

Skip

List of conditions under which to skip the build of the package.

type

array

items

type

string

  • script

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

  • noarch

Can be either ‘generic’ or ‘python’. A noarch ‘python’ package compiles .pyc files upon installation.

allOf

:ref:#/definitions/NoarchType

  • entry_points

Entry Points

type

array

items

type

string

  • run_exports

Run Exports

anyOf

:ref:#/definitions/RunExports

type

array

items

type

string

  • ignore_run_exports

Ignore Run Exports

type

array

items

type

string

  • ignore_run_exports_from

Ignore Run Exports From

type

array

items

type

string

  • track_features

Track Features

type

array

items

type

string

  • include_recipe

Include Recipe

Include recipe in final package.

type

boolean

default

True

  • pre-link

Pre-Link

Script to execute when installing - before linking. Highly discouraged!

type

string

  • post-link

Post-Link

Script to execute when installing - after linking.

type

string

  • pre-unlink

Pre-Unlink

Script to execute when removing - before unlinking.

type

string

  • osx_is_app

Osx Is App

type

boolean

default

False

  • disable_pip

Disable Pip

type

boolean

default

False

  • preserve_egg_dir

Preserve Egg Dir

type

boolean

default

False

  • no_link

No Link

type

array

items

type

string

pattern

^[^\]+$

  • binary_relocation

Binary Relocation

default

True

anyOf

type

boolean

type

array

items

type

string

pattern

^[^\]+$

  • has_prefix_files

Has Prefix Files

type

array

default

items

type

string

pattern

^[^\]+$

  • binary_has_prefix_files

Binary Has Prefix Files

type

array

items

type

string

pattern

^[^\]+$

  • ignore_prefix_files

Ignore Prefix Files

default

False

anyOf

type

boolean

type

array

items

type

string

pattern

^[^\]+$

  • detect_binary_files_with_prefix

Detect Binary Files With Prefix

type

boolean

  • skip_compile_pyc

Skip Compile Pyc

type

array

items

type

string

  • rpaths

Rpaths

type

array

items

type

string

  • rpaths_patcher

Rpaths Patcher

type

string

  • script_env

Script Env

type

object

additionalProperties

type

string

  • always_include_files

Always Include Files

type

array

items

type

string

  • force_use_keys

Force Use Keys

type

array

items

type

string

  • force_ignore_keys

Force Ignore Keys

type

array

items

type

string

  • merge_build_host

Merge Build Host

type

boolean

default

False

  • missing_dso_whitelist

Missing Dso Whitelist

type

array

items

type

string

  • error_overdepending

Error Overdepending

Error on overdepending

type

boolean

default

False

  • error_overlinking

Error Overlinking

Error on overlinking

type

boolean

default

False

additionalProperties

False

  • Requirements

Requirements

type

object

properties

  • build

Build

type

array

items

type

string

  • host

Host

type

array

items

type

string

  • run

Run

type

array

items

type

string

  • run_constrained

Run Constrained

type

array

items

type

string

  • Test

Test

type

object

properties

  • files

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

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

Requires

In addition to the runtime requirements, you can specify requirements needed during testing.

type

array

items

type

string

  • imports

Imports

Test importing modules.

type

array

items

type

string

  • commands

Commands

The test commands to execute.

type

array

items

type

string

  • Output

Output

type

object

properties

  • package

Package

The package name and version

allOf

:ref:#/definitions/Package

  • build

:ref:#/definitions/Build

  • requirements

:ref:#/definitions/Requirements

  • test

:ref:#/definitions/Test

  • About

About

type

object

properties

  • home

Home

type

string

  • dev_url

Dev Url

type

string

  • doc_url

Doc Url

type

string

  • doc_source_url

Doc Source Url

type

string

  • license_url

License Url

type

string

  • license

License

type

string

  • summary

Summary

type

string

  • description

Description

type

string

  • license_family

License Family

type

string

  • identifiers

Identifiers

type

array

items

type

string

  • tags

Tags

type

array

items

type

string

  • keywords

Keywords

type

array

items

type

string

  • license_file

License File

type

string

  • prelink_message

Prelink Message

type

string

  • readme

Readme

type

string