appveyor.yml

AppVeyor CI configuration file

appveyor.yml

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your appveyor.yml and it validates in your browser — nothing is uploaded.

Validate a appveyor.yml → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`version`	`string`	Version format
`branches`	`object`	Branches to build
`branches.only`	`array<string>`	Whitelist
`branches.except`	`array<string>`	Blacklist
`skip_tags`	`boolean`	Do not build on tags (GitHub and BitBucket)
`skip_non_tags`	`boolean`	Start builds on tags only (GitHub and BitBucket)
`skip_commits`	`object`	—
`skip_commits.message`	`string`	Regex for matching commit message
`skip_commits.author`	`anyOf`	Commit author's username, name, email or regexp matching one of these.
`skip_commits.files`	`array<string>`	Only specific files (glob patterns)
`only_commits`	`object`	—
`only_commits.message`	`string`	Regex for matching commit message
`only_commits.author`	`anyOf`	Commit author's username, name, email or regexp matching one of these.
`only_commits.files`	`array<string>`	Only specific files (glob patterns)
`skip_branch_with_pr`	`boolean`	Do not build feature branch with open Pull Requests
`max_jobs`	`integer`	Maximum number of concurrent jobs for the project
`notifications`	`array<object>`	—
`image`	`oneOf`	Build worker image (VM template) -DEV_VERSION
`init`	`array`	Scripts that are called at very beginning, before repo cloning
`clone_folder`	`string`	Clone directory
`shallow_clone`	`boolean`	Fetch repository as zip archive default: `false`
`clone_depth`	`integer`	Set git clone depth
`hosts`	`object`	Setting up etc\hosts file
`environment`	`anyOf`	Environment variables
`matrix`	`object`	—
`matrix.fast_finish`	`boolean`	Set this flag to immediately finish build once one of the jobs fails
`matrix.allow_failures`	`array`	This is how to allow failing jobs in the matrix
`matrix.exclude`	`array`	Exclude configuration from the matrix. Works similarly to 'allow_failures' but build not even being started for excluded combination.
`cache`	`array<string>`	Build cache to preserve files/folders between builds
`services`	`array`	Enable service required for build/tests
`install`	`array`	Scripts that run after cloning repository
`assembly_info`	`object`	Enable patching of AssemblyInfo.* files
`assembly_info.patch`	`boolean`	—
`assembly_info.file`	`string`	—
`assembly_info.assembly_version`	`string`	—
`assembly_info.assembly_file_version`	`string`	—
`assembly_info.assembly_informational_version`	`string`	—
`nuget`	`object`	Automatically register private account and/or project AppVeyor NuGet feeds
`nuget.account_feed`	`boolean`	—
`nuget.project_feed`	`boolean`	—
`nuget.disable_publish_on_pr`	`boolean`	Disable publishing of .nupkg artifacts to account/project feeds for pull request builds
`platform`	`oneOf`	Build platform, i.e. x86, x64, Any CPU. This setting is optional
`configuration`	`oneOf`	Build Configuration, i.e. Debug, Release, etc.
`build`	`oneOf`	—
`before_build`	`array`	Scripts to run before build
`before_package`	`array`	Scripts to run after solution is built and before automatic packaging occurs (web apps, NuGet packages, Azure Cloud Services)
`after_build`	`array`	Scripts to run after build
`build_script`	`array`	To run your custom scripts instead of automatic MSBuild
`before_test`	`array`	Scripts to run before tests
`test`	`oneOf`	—
`test_script`	`array`	To run your custom scripts instead of automatic tests
`after_test`	`array`	Scripts to run after tests
`artifacts`	`array<object>`	—
`before_deploy`	`array`	Scripts to run before deployment
`deploy`	`oneOf`	—
`deploy_script`	`array`	To run your custom scripts instead of provider deployments
`after_deploy`	`array`	Scripts to run after deployment
`on_success`	`array`	On successful build
`on_failure`	`array`	On build failure
`on_finish`	`array`	After build failure or success

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
90 properties, 71% carrying a description, max nesting depth 15.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$ref`	JSON Schema Core, draft 2020-12	§8.2.3.1 — Direct References with "$ref"
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`additionalProperties`	JSON Schema Core, draft 2020-12	§10.3.2.3 — "additionalProperties"
`allOf`	JSON Schema Core, draft 2020-12	§10.2.1.1 — "allOf"
`anyOf`	JSON Schema Core, draft 2020-12	§10.2.1.2 — "anyOf"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`enum`	JSON Schema Validation, draft 2020-12	§6.1.2 — "enum"
`format`	JSON Schema Validation, draft 2020-12	§7 — Vocabularies for Semantic Content With "format"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`oneOf`	JSON Schema Core, draft 2020-12	§10.2.1.3 — "oneOf"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas