update the info about validation outcome (tag->beta shift)

canonical · Jan 8, 2024 · 03d6daa · 03d6daa
1 parent 3bde5b8
commit 03d6daa
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 9 deletions.
diff --git a/docs/explanation/release_process/canary.rst b/docs/explanation/release_process/canary.rst
@@ -84,12 +84,11 @@ Canary Test Plan Criteria
 
 The canary test plan outlines specific tests that are imperative for the new snap's validation. The pipeline's successful conclusion is contingent upon all these tests passing on each of the mentioned platforms.
 
-Outcome and Commit Tagging
-----------------------------
+Outcome and Information propagation
+-----------------------------------
 
-The outcome of the process is a tag that's being assigned to the commit from which the snaps were built.
-The tag is either ``edge-validation-succeeded`` on success or ``edge-validation-failed`` otherwise.
-The tag is pushed to the Checkbox repository on GitHub.
+Should the validation complete without errors, the `beta` reference in the Checkbox repository is set to point at the revision that got validated.
+The `beta` branch head is then updated on GitHub.
 
 Conclusion
 ----------

diff --git a/docs/explanation/release_process/canary_pipeline.rst b/docs/explanation/release_process/canary_pipeline.rst
@@ -36,8 +36,8 @@ This is an example on how the whole pipeline can be implemented in Jenkins.
             always {
                 script {
                     def resultParam = currentBuild.resultIsBetterOrEqualTo('SUCCESS') ? 'edge-validation-succeeded' : 'edge-validation-failed'
-                    // Trigger the tagging job
-                    build job: 'checkbox-edge-validation-tag-and-finish', parameters: [string(name: 'RESULT', value: resultParam)]
+                    // Trigger the job shifting the beta reference
+                    build job: 'checkbox-edge-validation-move-beta', parameters: [string(name: 'RESULT', value: resultParam)]
                 }
             }
         }

diff --git a/docs/explanation/release_process/validation_pipeline_execution.rst b/docs/explanation/release_process/validation_pipeline_execution.rst
@@ -51,8 +51,8 @@ Once confirmed, the "Canary Test Plan" is executed. It is defined in the |hwcert
         A[Detect New Edge Version in Store]
         B{Check if All Necessary Snaps are Published}
         C{Run Canary Test Plan on Devices}
-        D[Tag as `edge-validation-failed``]
-        E[Tag as `edge-validation-completed``]
+        D[No changes in the repository]
+        E[Move `beta` HEAD to the point at the validated revision]
 
         A --> B
         B -->|No| D