releases/openstack_releases/schema.yaml
Sean McGinnis 8adf5e0b94 Add release highlights
This adds the ability to provide release highlights in the deliverable
yaml file. These highlights can then be extracted and displayed into
published documentation using a new 'cycle-highlights' directive.

Change-Id: I40791dad4b5a4d2c4089e5e43d52f00b52cc3217
2017-10-25 18:41:08 +00:00

83 lines
2.0 KiB
YAML

---
$schema: "http://json-schema.org/schema#"
$id: "http://git.openstack.org/cgit/openstack/releases/tree/README.rst"
# Do not allow any properties not defined here. This lets us catch
# typos.
additionalProperties: false
properties:
team:
type: "string"
launchpad:
type: "string"
storyboard:
type: "integer"
release-notes:
oneOf:
- type: "string"
# We don't include any details about the object form of the
# release notes because the keys are the repository names.
- type: "object"
include-pypi-link:
type: "boolean"
release-model:
type: "string"
enum: ["cycle-with-intermediary", "cycle-with-milestones", "cycle-trailing", "untagged"]
type:
type: "string"
enum: ["horizon-plugin", "library", "service", "other"]
artifact-link-mode:
type: "string"
enum: ["tarball", "none"]
repository-settings:
# TODO(dhellmann): Need to expand this to handle the flags.
type: "object"
release-type:
type: "string"
enum: [ "std", "xstatic", "fuel", "nodejs", "puppet" ]
stable-branch-type:
type: "string"
enum: [ "std", "tagless", "upstream" ]
cycle-highlights:
type: "string"
releases:
type: "array"
items:
type: "object"
properties:
version:
type: "string"
projects:
type: "array"
items:
type: "object"
properties:
repo:
type: "string"
hash:
type: "string"
highlights:
type: "string"
tarball-base:
type: "string"
diff-start:
type: "string"
highlights:
type: "string"
required: ["version", "projects"]
additionalProperties: False
branches:
type: "array"
items:
type: "object"
properties:
name:
type: "string"
location:
oneOf:
- type: "string"
- type: "object"
required: ["name", "location"]
additionalProperties: False