diff options
| author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-12-06 16:48:49 +0100 |
|---|---|---|
| committer | Steve Sakoman <steve@sakoman.com> | 2023-12-21 06:14:00 -1000 |
| commit | 306316eb80d6fe8386da6f69355f24a7186ba338 (patch) | |
| tree | ce72a0e3e1712af48488a4bdf5ab935c17b9c7c2 /documentation | |
| parent | 27ec491044aa6b5584e1360cbf8fd233cdaa9d99 (diff) | |
| download | poky-306316eb80d6fe8386da6f69355f24a7186ba338.tar.gz | |
test-manual: add or improve hyperlinks
(From yocto-docs rev: d6ea0c9c7713e265f5044548112f865348b21576)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/test-manual/test-process.rst | 32 | ||||
| -rw-r--r-- | documentation/test-manual/understand-autobuilder.rst | 31 |
2 files changed, 31 insertions, 32 deletions
diff --git a/documentation/test-manual/test-process.rst b/documentation/test-manual/test-process.rst index 0c560efe39..7bec5ba828 100644 --- a/documentation/test-manual/test-process.rst +++ b/documentation/test-manual/test-process.rst | |||
| @@ -20,8 +20,8 @@ helps review and test patches and this is his testing tree). | |||
| 20 | We have two broad categories of test builds, including "full" and | 20 | We have two broad categories of test builds, including "full" and |
| 21 | "quick". On the Autobuilder, these can be seen as "a-quick" and | 21 | "quick". On the Autobuilder, these can be seen as "a-quick" and |
| 22 | "a-full", simply for ease of sorting in the UI. Use our Autobuilder | 22 | "a-full", simply for ease of sorting in the UI. Use our Autobuilder |
| 23 | console view to see where me manage most test-related items, available | 23 | :yocto_ab:`console view </typhoon/#/console>` to see where we manage most |
| 24 | at: :yocto_ab:`/typhoon/#/console`. | 24 | test-related items. |
| 25 | 25 | ||
| 26 | Builds are triggered manually when the test branches are ready. The | 26 | Builds are triggered manually when the test branches are ready. The |
| 27 | builds are monitored by the SWAT team. For additional information, see | 27 | builds are monitored by the SWAT team. For additional information, see |
| @@ -34,18 +34,15 @@ which the result was required. | |||
| 34 | 34 | ||
| 35 | The Autobuilder does build the ``master`` branch once daily for several | 35 | The Autobuilder does build the ``master`` branch once daily for several |
| 36 | reasons, in particular, to ensure the current ``master`` branch does | 36 | reasons, in particular, to ensure the current ``master`` branch does |
| 37 | build, but also to keep ``yocto-testresults`` | 37 | build, but also to keep (:yocto_git:`yocto-testresults </yocto-testresults/>`), |
| 38 | (:yocto_git:`/yocto-testresults/`), | 38 | (:yocto_git:`buildhistory </poky-buildhistory/>`), and |
| 39 | buildhistory | 39 | our sstate up to date. On the weekend, there is a ``master-next`` build |
| 40 | (:yocto_git:`/poky-buildhistory/`), and | ||
| 41 | our sstate up to date. On the weekend, there is a master-next build | ||
| 42 | instead to ensure the test results are updated for the less frequently | 40 | instead to ensure the test results are updated for the less frequently |
| 43 | run targets. | 41 | run targets. |
| 44 | 42 | ||
| 45 | Performance builds (``buildperf-\*`` targets in the console) are triggered | 43 | Performance builds (``buildperf-\*`` targets in the console) are triggered |
| 46 | separately every six hours and automatically push their results to the | 44 | separately every six hours and automatically push their results to the |
| 47 | buildstats repository at: | 45 | :yocto_git:`buildstats </yocto-buildstats/>` repository. |
| 48 | :yocto_git:`/yocto-buildstats/`. | ||
| 49 | 46 | ||
| 50 | The "quick" targets have been selected to be the ones which catch the | 47 | The "quick" targets have been selected to be the ones which catch the |
| 51 | most failures or give the most valuable data. We run "fast" ptests in | 48 | most failures or give the most valuable data. We run "fast" ptests in |
| @@ -69,10 +66,10 @@ configured to generate and publish artifacts and the milestone number, | |||
| 69 | version, release candidate number and other information is entered. The | 66 | version, release candidate number and other information is entered. The |
| 70 | box to "generate an email to QA" is also checked. | 67 | box to "generate an email to QA" is also checked. |
| 71 | 68 | ||
| 72 | When the build completes, an email is sent out using the send-qa-email | 69 | When the build completes, an email is sent out using the ``send-qa-email`` |
| 73 | script in the ``yocto-autobuilder-helper`` repository to the list of | 70 | script in the :yocto_git:`yocto-autobuilder-helper </yocto-autobuilder-helper>` |
| 74 | people configured for that release. Release builds are placed into a | 71 | repository to the list of people configured for that release. Release builds |
| 75 | directory in https://autobuilder.yocto.io/pub/releases on the | 72 | are placed into a directory in https://autobuilder.yocto.io/pub/releases on the |
| 76 | Autobuilder which is included in the email. The process from here is | 73 | Autobuilder which is included in the email. The process from here is |
| 77 | more manual and control is effectively passed to release engineering. | 74 | more manual and control is effectively passed to release engineering. |
| 78 | The next steps include: | 75 | The next steps include: |
| @@ -80,14 +77,15 @@ The next steps include: | |||
| 80 | - QA teams respond to the email saying which tests they plan to run and | 77 | - QA teams respond to the email saying which tests they plan to run and |
| 81 | when the results will be available. | 78 | when the results will be available. |
| 82 | 79 | ||
| 83 | - QA teams run their tests and share their results in the yocto- | 80 | - QA teams run their tests and share their results in the |
| 84 | testresults-contrib repository, along with a summary of their | 81 | :yocto_git:`yocto-testresults-contrib </yocto-testresults-contrib>` |
| 85 | findings. | 82 | repository, along with a summary of their findings. |
| 86 | 83 | ||
| 87 | - Release engineering prepare the release as per their process. | 84 | - Release engineering prepare the release as per their process. |
| 88 | 85 | ||
| 89 | - Test results from the QA teams are included into the release in | 86 | - Test results from the QA teams are included into the release in |
| 90 | separate directories and also uploaded to the yocto-testresults | 87 | separate directories and also uploaded to the |
| 88 | :yocto_git:`yocto-testresults </yocto-testresults>` | ||
| 91 | repository alongside the other test results for the given revision. | 89 | repository alongside the other test results for the given revision. |
| 92 | 90 | ||
| 93 | - The QA report in the final release is regenerated using resulttool to | 91 | - The QA report in the final release is regenerated using resulttool to |
diff --git a/documentation/test-manual/understand-autobuilder.rst b/documentation/test-manual/understand-autobuilder.rst index ef03955954..11e2ceb12f 100644 --- a/documentation/test-manual/understand-autobuilder.rst +++ b/documentation/test-manual/understand-autobuilder.rst | |||
| @@ -9,8 +9,8 @@ Execution Flow within the Autobuilder | |||
| 9 | 9 | ||
| 10 | The "a-full" and "a-quick" targets are the usual entry points into the | 10 | The "a-full" and "a-quick" targets are the usual entry points into the |
| 11 | Autobuilder and it makes sense to follow the process through the system | 11 | Autobuilder and it makes sense to follow the process through the system |
| 12 | starting there. This is best visualized from the Autobuilder Console | 12 | starting there. This is best visualized from the :yocto_ab:`Autobuilder |
| 13 | view (:yocto_ab:`/typhoon/#/console`). | 13 | Console view </typhoon/#/console>`. |
| 14 | 14 | ||
| 15 | Each item along the top of that view represents some "target build" and | 15 | Each item along the top of that view represents some "target build" and |
| 16 | these targets are all run in parallel. The 'full' build will trigger the | 16 | these targets are all run in parallel. The 'full' build will trigger the |
| @@ -18,9 +18,9 @@ majority of them, the "quick" build will trigger some subset of them. | |||
| 18 | The Autobuilder effectively runs whichever configuration is defined for | 18 | The Autobuilder effectively runs whichever configuration is defined for |
| 19 | each of those targets on a separate buildbot worker. To understand the | 19 | each of those targets on a separate buildbot worker. To understand the |
| 20 | configuration, you need to look at the entry on ``config.json`` file | 20 | configuration, you need to look at the entry on ``config.json`` file |
| 21 | within the ``yocto-autobuilder-helper`` repository. The targets are | 21 | within the :yocto_git:`yocto-autobuilder-helper </yocto-autobuilder-helper>` |
| 22 | defined in the ‘overrides' section, a quick example could be qemux86-64 | 22 | repository. The targets are defined in the ``overrides`` section, a quick |
| 23 | which looks like:: | 23 | example could be ``qemux86-64`` which looks like:: |
| 24 | 24 | ||
| 25 | "qemux86-64" : { | 25 | "qemux86-64" : { |
| 26 | "MACHINE" : "qemux86-64", | 26 | "MACHINE" : "qemux86-64", |
| @@ -88,9 +88,9 @@ roughly consist of: | |||
| 88 | 88 | ||
| 89 | #. *Obtain yocto-autobuilder-helper* | 89 | #. *Obtain yocto-autobuilder-helper* |
| 90 | 90 | ||
| 91 | This step clones the ``yocto-autobuilder-helper`` git repository. | 91 | This step clones the :yocto_git:`yocto-autobuilder-helper </yocto-autobuilder-helper>` |
| 92 | This is necessary to prevent the requirement to maintain all the | 92 | git repository. This is necessary to avoid the requirement to maintain all |
| 93 | release or project-specific code within Buildbot. The branch chosen | 93 | the release or project-specific code within Buildbot. The branch chosen |
| 94 | matches the release being built so we can support older releases and | 94 | matches the release being built so we can support older releases and |
| 95 | still make changes in newer ones. | 95 | still make changes in newer ones. |
| 96 | 96 | ||
| @@ -255,13 +255,14 @@ Deploying Yocto Autobuilder | |||
| 255 | =========================== | 255 | =========================== |
| 256 | 256 | ||
| 257 | The most up to date information about how to setup and deploy your own | 257 | The most up to date information about how to setup and deploy your own |
| 258 | Autobuilder can be found in README.md in the ``yocto-autobuilder2`` | 258 | Autobuilder can be found in :yocto_git:`README.md </yocto-autobuilder2/tree/README.md>` |
| 259 | repository. | 259 | in the :yocto_git:`yocto-autobuilder2 </yocto-autobuilder2>` repository. |
| 260 | 260 | ||
| 261 | We hope that people can use the ``yocto-autobuilder2`` code directly but | 261 | We hope that people can use the :yocto_git:`yocto-autobuilder2 </yocto-autobuilder2>` |
| 262 | it is inevitable that users will end up needing to heavily customise the | 262 | code directly but it is inevitable that users will end up needing to heavily |
| 263 | ``yocto-autobuilder-helper`` repository, particularly the | 263 | customize the :yocto_git:`yocto-autobuilder-helper </yocto-autobuilder-helper>` |
| 264 | ``config.json`` file as they will want to define their own test matrix. | 264 | repository, particularly the ``config.json`` file as they will want to define |
| 265 | their own test matrix. | ||
| 265 | 266 | ||
| 266 | The Autobuilder supports two customization options: | 267 | The Autobuilder supports two customization options: |
| 267 | 268 | ||
