From 6f0dc28878715eb4ab8d5f71c6c3ed0a3eb64540 Mon Sep 17 00:00:00 2001 From: Thierry Carrez Date: Thu, 6 Jun 2019 12:10:45 +0200 Subject: [PATCH] Document tag pipeline jobs in contributor doc While debugging a release failure this morning I realized that the magic job diagram was missing the release notes publication jobs that are in the "tag" pipeline. Change-Id: I2879de0df530ccf96ac4be61c42ce07472399b4e --- CONTRIBUTING.rst | 39 ++++++++++++++++++++------------------- 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index fc197de585..dc5a46b4e2 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -71,32 +71,33 @@ Release request merged +-------+-------+ +---------------+ 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 -versions) of the repository the tag landed in: +of jobs in the "tag" pipeline and the "release" pipeline (or "pre-release" +pipeline, in case of beta versions) of the repository the tag landed in: - Tag is created - | - +----v------------------------------------+ - Release pipeline (each repo) - +----+---------------+---------------+----+ - | | | - v v v - +-----+-----+ +-----+-----+ +-----+-----+ - | release | | announce | | propose | - | | | | |constraints| - |(builds | | (sends | | update | - | tarball | | email) | | | - | & uploads | | | +-----------+ + Tag is created ----------------------------------------------- + | | + +----v------------------------------------+ +----------v-----------+ + Release pipeline (each repo) Tag pipeline (each repo) + +----+---------------+---------------+----+ +----------------------+ + | | | | + v v v v + +-----+-----+ +-----+-----+ +-----+-----+ +-----+-----+ + | release | | announce | | propose | | publish | + | | | | |constraints| | release | + |(builds | | (sends | | update | | notes | + | tarball | | email) | | | | | + | & uploads | | | +-----------+ +-----------+ | it) | +-----------+ +-----------+ Note that a single release request can create multiple tags in different repositories, triggering that second stage in multiple repositories. -Jobs in step 2 need information from the release request (like series name, -or whether to upload to pypi). We use metadata in the git tag itself to pass -that information: the "tag" job in step 1 records the information in the tag, -and the jobs in step 2 retrieve that information directly from the tag. +Jobs in the release pipeline need information from the release request +(like series name, or whether to upload to pypi). We use metadata in the +git tag itself to pass that information: the "tag" job in step 1 records +the information in the tag, and the jobs in step 2 retrieve that information +directly from the tag. Checklist before approving a release