From 3ae0001273833bb4649b26a9c5345608863f8185 Mon Sep 17 00:00:00 2001 From: Nico Jensch Date: Tue, 7 Nov 2023 19:29:40 +0100 Subject: [PATCH] docs: update with information about new configurations --- docs/src/nixos-containers/github-runner.md | 2 +- docs/src/nixos-containers/repo.md | 20 ++++++++++++++++++++ docs/src/repositories/general.md | 5 +++++ 3 files changed, 26 insertions(+), 1 deletion(-) diff --git a/docs/src/nixos-containers/github-runner.md b/docs/src/nixos-containers/github-runner.md index 70113e8..21e1369 100644 --- a/docs/src/nixos-containers/github-runner.md +++ b/docs/src/nixos-containers/github-runner.md @@ -2,7 +2,7 @@ ## General -With this container, we provide a GitHub runner. This container does **not** have the regular Garuda configurations because it is considered untrusted. +With this container, we provide a GitHub runner as well as (more recently), a GitLab runner. This container does **not** have the regular Garuda configurations because it is considered untrusted. Access needs to happen by running `nixos-container root-login` on `immortalis` ([click me](http://docs.garudalinux.net/hosts/immortalis.html#connecting-to-the-server)). ## Nix expression diff --git a/docs/src/nixos-containers/repo.md b/docs/src/nixos-containers/repo.md index c80d128..8dd81af 100644 --- a/docs/src/nixos-containers/repo.md +++ b/docs/src/nixos-containers/repo.md @@ -3,6 +3,26 @@ ## General This is another package builder, that builds packages for our `[garuda]` repository. +This builder is accessed by the [PKGBUILD repos](https://gitlab.com/garuda-linux/pkgbuilds) CI pipelines via SSH to trigger package deployments. + +## How to request a build via CI + +To lock down any possible action, access has been restricted to a command wrapper. Allowed actions for the `gitlab` user are: + +1. Building a specific package +2. Building a full routine + +In order to trigger these actions, one needs to do the following: + +1. `ssh -p 223 gitlab@builds.garudalinux.org chaotictrigger $pkgname` +2. `ssh -p 223 gitlab@builds.garudalinux.org chaotictrigger routine` + +For our PKGBUILD repo, it has been implemented via this [pipeline](https://gitlab.com/garuda-linux/pkgbuilds/-/blob/main/.gitlab-ci.yml?ref_type=heads#L69). + +## How packages get built + +We switched to a CI-driven workflow for deploying new packages of the `garuda` repository, more details on how to operate the process can be found in the [repository section](../repositories/general.md). +The GitLab runner used to build the packages is located in the untrusted [github-runner](./github-runner.md) container. ## Nix expression diff --git a/docs/src/repositories/general.md b/docs/src/repositories/general.md index 60e97cb..2d4e24b 100644 --- a/docs/src/repositories/general.md +++ b/docs/src/repositories/general.md @@ -1,5 +1,10 @@ # Repositories +## Notifications for new events at GitLab + +Since GitLab has an inbuilt Telegram integration, we can leverage this feature to send notifications to our a dedicated [Telegram development updates channel](https://t.me/garuda_updates). +Posts are send for all kinds of relevent, but non-confidential events like commits, comments or new merge requests. Failed pipelines would also be reported here. + ## Backing up current repositories Current repositories may be backed up using [ghorg](https://github.com/gabrie30/ghorg).