make the docs for drivefixes match the code

The validation logic for driverfixes branches requires a mapping of repo
name to SHA. Update the README to reflect the correct rules.

Change-Id: I1f77c15fa0843b4fc0975b230530d08cc2957acf
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
Doug Hellmann 2017-05-07 09:09:37 -04:00
parent 93746f1906
commit 8c4417b036
1 changed files with 37 additions and 2 deletions

View File

@ -405,8 +405,8 @@ Each ``branch`` entry is a mapping with keys:
already in the target repository.
If a branch name starts with driverfixes/ then the location must be
a SHA of a commit already in the target repository on the associated
stable branch.
a mapping between the target repository name and the SHA of a commit
already in the target repository on the associated stable branch.
Examples
@ -450,6 +450,41 @@ and then for the subsequent release it would be updated to contain::
This release includes the change to stop importing
from the 'oslo' namespace package.
A driverfixes branch might be added to a project in a similar
way. This example shows the branch created in cinder for the newton
series. The branch was created from the HEAD of the stable/newton
branch at the time.
::
---
launchpad: cinder
team: cinder
type: service
release-model: cycle-with-milestones
release-notes: https://docs.openstack.org/releasenotes/cinder/newton.html
branches:
- name: stable/newton
location: 9.0.0.0rc1
- name: driverfixes/newton
location:
openstack/cinder: 08bfc7d817f313451e619b535299121b686d7bd8
releases:
# ...
- version: 9.0.0.0rc1
projects:
- repo: openstack/cinder
hash: 0ba267fbc1836722735102994b466ecd7803b10a
- version: 9.0.0.0rc2
projects:
- repo: openstack/cinder
hash: ab9518112137f3141739e873b19cdc0085963bc7
# ...
- version: 9.1.4
projects:
- repo: openstack/cinder
hash: 908def6bb993798146cccc1621a9cee18950629d
For deliverables with multiple repositories, the list of projects
would contain all of them. For example, the Neutron deliverable might
be described by ``deliverables/mitaka/neutron.yaml`` containing: