Merge "Document tag pipeline jobs in contributor doc"

This commit is contained in:
Zuul 2019-06-14 00:55:34 +00:00 committed by Gerrit Code Review
commit 87f24b4444

View File

@ -71,32 +71,33 @@ Release request merged
+-------+-------+ +---------------+ +-------+-------+ +---------------+
The second step is triggered by the creation of the tag, creating a series The second step is triggered by the creation of the tag, creating a series
of jobs in the "release" pipeline (or "pre-release" pipeline, in case of beta of jobs in the "tag" pipeline and the "release" pipeline (or "pre-release"
versions) of the repository the tag landed in: pipeline, in case of beta versions) of the repository the tag landed in:
Tag is created Tag is created -----------------------------------------------
| | |
+----v------------------------------------+ +----v------------------------------------+ +----------v-----------+
Release pipeline (each repo) Release pipeline (each repo) Tag pipeline (each repo)
+----+---------------+---------------+----+ +----+---------------+---------------+----+ +----------------------+
| | | | | | |
v v v v v v v
+-----+-----+ +-----+-----+ +-----+-----+ +-----+-----+ +-----+-----+ +-----+-----+ +-----+-----+
| release | | announce | | propose | | release | | announce | | propose | | publish |
| | | | |constraints| | | | | |constraints| | release |
|(builds | | (sends | | update | |(builds | | (sends | | update | | notes |
| tarball | | email) | | | | tarball | | email) | | | | |
| & uploads | | | +-----------+ | & uploads | | | +-----------+ +-----------+
| it) | +-----------+ | it) | +-----------+
+-----------+ +-----------+
Note that a single release request can create multiple tags in different Note that a single release request can create multiple tags in different
repositories, triggering that second stage in multiple repositories. repositories, triggering that second stage in multiple repositories.
Jobs in step 2 need information from the release request (like series name, Jobs in the release pipeline need information from the release request
or whether to upload to pypi). We use metadata in the git tag itself to pass (like series name, or whether to upload to pypi). We use metadata in the
that information: the "tag" job in step 1 records the information in the tag, git tag itself to pass that information: the "tag" job in step 1 records
and the jobs in step 2 retrieve that information directly from the tag. the information in the tag, and the jobs in step 2 retrieve that information
directly from the tag.
Checklist before approving a release Checklist before approving a release