Document GitLab CI

Author: thomas-zahner

astro.config.mjs

@@ -75,7 +75,10 @@ export default defineConfig({
         },
         {
           label: "Continuous integration",
-          items: ["github_action_recipes/check-repository"],
+          items: [
+            "continuous-integration/github",
+            "continuous-integration/gitlab",
+          ],
         },
         {
           label: "Troubleshooting",

…thub_action_recipes/check-repository.mdx …t/docs/continuous-integration/github.mdxsrc/content/docs/github_action_recipes/check-repository.mdx renamed to src/content/docs/continuous-integration/github.mdx src/content/docs/github_action_recipes/check-repository.mdx renamed to src/content/docs/continuous-integration/github.mdx

@@ -1,5 +1,5 @@
 ---
-title: GitHub CI action recipes
+title: GitHub CI recipes
 ---
 
 import CodeBlock from "../../../components/code.astro";

src/content/docs/continuous-integration/gitlab.mdx

@@ -0,0 +1,30 @@
+---
+title: GitLab CI recipes
+---
+
+import CodeBlock from "../../../components/code.astro";
+import { Aside } from "@astrojs/starlight/components";
+
+## Basic example
+
+This recipe demonstrates how to set up a CI job to check links in a repository.
+GitLab integrates nicely with the JUnit XML report format.
+This makes it easy to visualise link check results as test reports,
+as shown in the below screenshot.
+
+![The GitLab PR showing a test summary where 2 out of 12 tests failed, where each test indicates a link check](images/junit-annotations-gitlab.png)
+
+```yaml
+Check links:
+  stage: test
+  script:
+    - apt-get update -qq && apt-get install -y -qq wget
+    # recommended to pin a stable version such as "lychee-v0.24.0"
+    - version="nightly"
+    - wget -qO- "https://github.com/lycheeverse/lychee/releases/download/$version/lychee-x86_64-unknown-linux-gnu.tar.gz" | tar -xz
+    - ./lychee --verbose --include-mail --format junit --output results.xml TEST.md
+  artifacts:
+    when: always
+    reports:
+      junit: results.xml
+```

src/content/docs/continuous-integration/images/junit-annotations-gitlab.png

@@ -45,4 +45,4 @@ docker run -it -v $(pwd)/.lycheecache:/.lycheecache lycheeverse/lychee --cache -
 
 ## Caching in GitHub Actions
 
-To see how you can cache the results of a lychee run in GitHub Actions, [check out this page](/github_action_recipes/caching).
+To see how you can cache the results of a lychee run in GitHub Actions, [check out this page](/continuous-integration/github#caching).

…ipes/images/junit-inline-annotations.png …tion/images/junit-inline-annotations.pngsrc/content/docs/github_action_recipes/images/junit-inline-annotations.png renamed to src/content/docs/continuous-integration/images/junit-inline-annotations.png src/content/docs/github_action_recipes/images/junit-inline-annotations.png renamed to src/content/docs/continuous-integration/images/junit-inline-annotations.png

@@ -78,4 +78,4 @@ If the `--cache` flag is used, this can also help to reduce the amount of calls
 that are sent to a page because only links that exceed the cache age are queried
 again. This value can be adjusted with `--max-cache-age`, e.g. `12h`.
 If you run into rate-limiting issues when using the GitHub Action,
-see the [caching configuration here](/github_action_recipes/caching).
+see the [caching configuration here](/continuous-integration/github#caching).