NOTE: as of 2018.08, meta-release metadata will no longer be stored in releases/. This system has been replaced by the component metadata system described below. The original readme has been moved to the releases/ directory for reference.
This repository stores metadata about RPC component releases.
Each component is represented by a file in components/. This file contains the name of the component, description and a list of all released versions of the component.
The file is yaml, so should begin ---
The yaml document contains a number of top-level entries:
- artifact_stores: A list of artefact stores.
- description: Short explanation of the use of the artefact store.
- name: Unique name to identify the artefact store.
- public_url: URL to the artefacts.
- type: Currently only the type file is supported.
- is_product: true/false
- name: String, name of the component, usually the filename without
.yml
- repo_url: The URL of the repository where the code for this component is stored
- releases: Dictionary containing at least one series entry
- series: Name of the component series (e.g.
master
) - versions: Dictionary containing information about the released versions
- sha: sha of the released version
- version: version number of the released version
- series: Name of the component series (e.g.
Example:
---
artifact_stores:
- description: "Artefact used in production deployments"
name: release-artifacts
public_url: https://example.com/artefacts
type: file
is_product: false
name: rpc-component-2
releases:
- series: master
versions:
- sha: 8fdcb3e99a71e1eeb0014484bb6492078402e563
version: 1.0.2
- sha: 7646f1d0ef46b997fa976efb1faa99c47b2e6cb4
version: 1.0.1
- sha: 76ee8bcd8862e4fb7c48e40fbf8110df80bd747c
version: 1.0.0