From: Eric Anholt Date: Tue, 7 Jul 2020 03:53:31 +0000 (-0700) Subject: docs: Move the current CI .rst doc to docs/ci/ and link to it from .gitlab-ci. X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=9af82b50264698e90d8914e9499d6301f875483a;p=mesa.git docs: Move the current CI .rst doc to docs/ci/ and link to it from .gitlab-ci. I want the docs to be discoverable next to the code, and sphinx insists that all docs are under the top-level docs dir (sigh). We can't symlink from that dir to .gitlab-ci because windows builds can't do symlinks, so link back the other direction. Reviewed-by: Eric Engestrom Reviewed-by: Erik Faye-Lund Part-of: --- diff --git a/.gitlab-ci/docs b/.gitlab-ci/docs new file mode 120000 index 00000000000..af422dba8f1 --- /dev/null +++ b/.gitlab-ci/docs @@ -0,0 +1 @@ +../docs/ci \ No newline at end of file diff --git a/docs/ci.rst b/docs/ci.rst deleted file mode 100644 index 3ba56beaff2..00000000000 --- a/docs/ci.rst +++ /dev/null @@ -1,76 +0,0 @@ -Continuous Integration & Testing -================================ - - -GitLab CI ---------- - -GitLab provides a convenient framework for running commands in response to git pushes. -We use it to test merge requests (MRs) before merging them (pre-merge testing), -as well as post-merge testing, for everything that hits ``master`` -(this is necessary because we still allow commits to be pushed outside of MRs, -and even then the MR CI runs in the forked repository, which might have been -modified and thus is unreliable). - -The CI runs a number of tests, from trivial build-testing to complex GPU rendering: - -- Build testing for a number of build systems, configurations and platforms -- Sanity checks (``meson test`` & ``scons check``) -- Some drivers (softpipe, llvmpipe, freedreno and panfrost) are also tested - using `VK-GL-CTS `__ - -A typical run takes between 20 and 30 minutes, although it can go up very quickly -if the GitLab runners are overwhelmed, which happens sometimes. When it does happen, -not much can be done besides waiting it out, or cancel it. - -Due to limited resources, we currently do not run the CI automatically -on every push; instead, we only run it automatically once the MR has -been assigned to ``Marge``, our merge bot. - -If you're interested in the details, the main configuration file is ``.gitlab-ci.yml``, -and it references a number of other files in ``.gitlab-ci/``. - -If the GitLab CI doesn't seem to be running on your fork (or MRs, as they run -in the context of your fork), you should check the "Settings" of your fork. -Under "CI / CD" → "General pipelines", make sure "Custom CI config path" is -empty (or set to the default ``.gitlab-ci.yml``), and that the -"Public pipelines" box is checked. - -If you're having issues with the GitLab CI, your best bet is to ask -about it on ``#freedesktop`` on Freenode and tag `Daniel Stone -`__ (``daniels`` on IRC) or -`Eric Anholt `__ (``anholt`` on -IRC). - - -Intel CI --------- - -The Intel CI is not yet integrated into the GitLab CI. -For now, special access must be manually given (file a issue in -`the Intel CI configuration repo `__ -if you think you or Mesa would benefit from you having access to the Intel CI). -Results can be seen on `mesa-ci.01.org `__ -if you are *not* an Intel employee, but if you are you -can access a better interface on -`mesa-ci-results.jf.intel.com `__. - -The Intel CI runs a much larger array of tests, on a number of generations -of Intel hardware and on multiple platforms (x11, wayland, drm & android), -with the purpose of detecting regressions. -Tests include -`Crucible `__, -`VK-GL-CTS `__, -`dEQP `__, -`Piglit `__, -`Skia `__, -`VkRunner `__, -`WebGL `__, -and a few other tools. -A typical run takes between 30 minutes and an hour. - -If you're having issues with the Intel CI, your best bet is to ask about -it on ``#dri-devel`` on Freenode and tag `Clayton Craft -`__ (``craftyguy`` on IRC) or -`Nico Cortes `__ (``ngcortes`` -on IRC). diff --git a/docs/ci/index.rst b/docs/ci/index.rst new file mode 100644 index 00000000000..3ba56beaff2 --- /dev/null +++ b/docs/ci/index.rst @@ -0,0 +1,76 @@ +Continuous Integration & Testing +================================ + + +GitLab CI +--------- + +GitLab provides a convenient framework for running commands in response to git pushes. +We use it to test merge requests (MRs) before merging them (pre-merge testing), +as well as post-merge testing, for everything that hits ``master`` +(this is necessary because we still allow commits to be pushed outside of MRs, +and even then the MR CI runs in the forked repository, which might have been +modified and thus is unreliable). + +The CI runs a number of tests, from trivial build-testing to complex GPU rendering: + +- Build testing for a number of build systems, configurations and platforms +- Sanity checks (``meson test`` & ``scons check``) +- Some drivers (softpipe, llvmpipe, freedreno and panfrost) are also tested + using `VK-GL-CTS `__ + +A typical run takes between 20 and 30 minutes, although it can go up very quickly +if the GitLab runners are overwhelmed, which happens sometimes. When it does happen, +not much can be done besides waiting it out, or cancel it. + +Due to limited resources, we currently do not run the CI automatically +on every push; instead, we only run it automatically once the MR has +been assigned to ``Marge``, our merge bot. + +If you're interested in the details, the main configuration file is ``.gitlab-ci.yml``, +and it references a number of other files in ``.gitlab-ci/``. + +If the GitLab CI doesn't seem to be running on your fork (or MRs, as they run +in the context of your fork), you should check the "Settings" of your fork. +Under "CI / CD" → "General pipelines", make sure "Custom CI config path" is +empty (or set to the default ``.gitlab-ci.yml``), and that the +"Public pipelines" box is checked. + +If you're having issues with the GitLab CI, your best bet is to ask +about it on ``#freedesktop`` on Freenode and tag `Daniel Stone +`__ (``daniels`` on IRC) or +`Eric Anholt `__ (``anholt`` on +IRC). + + +Intel CI +-------- + +The Intel CI is not yet integrated into the GitLab CI. +For now, special access must be manually given (file a issue in +`the Intel CI configuration repo `__ +if you think you or Mesa would benefit from you having access to the Intel CI). +Results can be seen on `mesa-ci.01.org `__ +if you are *not* an Intel employee, but if you are you +can access a better interface on +`mesa-ci-results.jf.intel.com `__. + +The Intel CI runs a much larger array of tests, on a number of generations +of Intel hardware and on multiple platforms (x11, wayland, drm & android), +with the purpose of detecting regressions. +Tests include +`Crucible `__, +`VK-GL-CTS `__, +`dEQP `__, +`Piglit `__, +`Skia `__, +`VkRunner `__, +`WebGL `__, +and a few other tools. +A typical run takes between 30 minutes and an hour. + +If you're having issues with the Intel CI, your best bet is to ask about +it on ``#dri-devel`` on Freenode and tag `Clayton Craft +`__ (``craftyguy`` on IRC) or +`Nico Cortes `__ (``ngcortes`` +on IRC). diff --git a/docs/contents.rst b/docs/contents.rst index 4403bc0898d..f825ba8cbdc 100644 --- a/docs/contents.rst +++ b/docs/contents.rst @@ -61,7 +61,7 @@ devinfo codingstyle submittingpatches - ci + ci/index releasing release-calendar sourcedocs