package semanticrelease

// semantic-release Schema
#Schema: {
	@jsonschema(schema="http://json-schema.org/draft-07/schema#")
	@jsonschema(id="https://json.schemastore.org/semantic-release.json")

	// List of modules or file paths containing a shareable configuration. If
	// multiple shareable configurations are set, they will be imported in the
	// order defined with each configuration option taking precedence over the
	// options defined in a previous shareable configuration
	extends?: matchN(1, [string, [...string]])

	// The branches on which releases should happen.
	branches?: matchN(1, [string, #."branch-object", [...matchN(>=1, [string, #."branch-object"])]])

	// The git repository URL
	repositoryUrl?: string

	// The Git tag format used by semantic-release to identify releases. The tag
	// name is generated with Lodash template and will be compiled with the version
	// variable.
	tagFormat?: string

	// Define the list of plugins to use. Plugins will run in series, in the order defined
	plugins?: [...matchN(>=1, [
		string,
		[...], {
			path!: string
			...
		}
	])]

	// The objective of the dry-run mode is to get a preview of the pending release.
	// Dry-run mode skips the following steps: prepare, publish, success and fail.
	// In addition to this it prints the next version and release notes to the
	// console
	dryRun?: bool

	// Set to false to skip Continuous Integration environment verifications. This
	// allows for making releases from a local machine
	ci?: bool

	#: "branch-object": close({
		name!:       string
		channel?:    string
		range?:      string
		prerelease?: bool | string
	})
	...
}