BlueGit

timfa bluegit

Files

bluegit / docs / AUR.md

AUR.md

feat: publiceer bluegit naar de AUR bij een push naar master
timfa project_87923614_bot_3aff574f6f98414b945a8799374f9092 · pushed by timfa · 3 weeks ago
a47e8c3a History
AUR.md 2.8 KiB Download Raw

AUR

Elke push naar master werkt packaging/aur/PKGBUILD bij en pusht die naar ssh://aur@aur.archlinux.org/bluegit.git (branch master; AUR accepteert niets anders). De aanpak en de geheimnamen zijn dezelfde als in Posprint. Posprint publiceert bij een tag; BlueGit doet het bij elke commit op master, omdat er geen vaste versietag is.

Package

Er is één source-package, bluegit. Geen -bin. De PKGBUILD haalt de GitLab-archieven op:

https://gitlab.com/Timfa/bluegit/-/archive/<commit>/bluegit-<commit>.tar.gz

Die map heet bluegit-<commit>. pkgver is YYYYMMDDHHMMSS van CI_COMMIT_TIMESTAMP (of de klok van de job) en stijgt per push. pkgrel gaat terug naar 1. _commit is de volledige sha. Het script vult sha256sums met de hash van dat archief en maakt .SRCINFO opnieuw met makepkg --printsrcinfo. Draait de job als root, dan doet gebruiker aurbuild dat (AUR_MAKEPKG_USER overschrijft de naam).

De lokale packaging/arch/PKGBUILD blijft voor een build uit de werkboom. Die gaat niet naar de AUR.

Unit en install-hook

De unit is de bestaande system-unit: User=bluegit, ExecStart met /etc/bluegit/config.yml, StateDirectory=bluegit voor /var/lib/bluegit. Geen systemd --user-unit.

packaging/aur/bluegit.install draait na installatie en upgrade systemd-sysusers, systemd-tmpfiles --create en systemctl daemon-reload. Hij zet de service niet aan en schrijft config.yml niet over. backup=('etc/bluegit/config.yml') laat een aangepaste config staan.

Geheimen

Tim zet deze zelf. De publieke sleutel hoort op aur.archlinux.org, nooit de private sleutel in de repository.

NaamSoortInhoud
AUR_SSH_PRIVATE_KEYFile, mask uit, protected magruwe OpenSSH-sleutel (BEGIN … PRIVATE KEY). Een File met base64 wordt ook herkend.
AUR_SSH_PRIVATE_KEY_B64Variable, één regel, Masked+Protectedbase64 van die sleutel. GitLab maskeert geen meerregelige waarde, daarom base64 of een File.
AUR_GIT_AUTHOR_NAMEVariablenaam in de AUR-commit
AUR_GIT_AUTHOR_EMAILVariablee-mail in de AUR-commit

Eén van de twee sleutelvariabelen is genoeg. scripts/aur-ssh-setup.sh haalt CRLF weg en controleert de sleutel met ssh-keygen -y zonder hem te printen.

De job heet publish:aur in .gitlab-ci.yml en publish_aur in blue-ci-cd.yml. Beide draaien alleen op master (BlueGit ook op main) en hebben allow_failure: true, zodat een storing bij de AUR de rest van de pipeline niet rood maakt.

Archief moet leesbaar zijn

Een anonieme download van het GitLab-archief gaf 403. De publish-job kan het archief met CI_JOB_TOKEN ophalen om de hash te zetten, maar een AUR-gebruiker die makepkg draait heeft die token niet. Het project, of in elk geval dat archief-adres, moet publiek leesbaar zijn voordat een installatie vanaf de AUR slaagt.

Source
1# AUR
2
3Elke push naar `master` werkt `packaging/aur/PKGBUILD` bij en pusht die naar `ssh://aur@aur.archlinux.org/bluegit.git` (branch `master`; AUR accepteert niets anders). De aanpak en de geheimnamen zijn dezelfde als in Posprint. Posprint publiceert bij een tag; BlueGit doet het bij elke commit op `master`, omdat er geen vaste versietag is.
4
5## Package
6
7Er is één source-package, `bluegit`. Geen `-bin`. De PKGBUILD haalt de GitLab-archieven op:
8
9```text
10https://gitlab.com/Timfa/bluegit/-/archive/<commit>/bluegit-<commit>.tar.gz
11```
12
13Die map heet `bluegit-<commit>`. `pkgver` is `YYYYMMDDHHMMSS` van `CI_COMMIT_TIMESTAMP` (of de klok van de job) en stijgt per push. `pkgrel` gaat terug naar 1. `_commit` is de volledige sha. Het script vult `sha256sums` met de hash van dat archief en maakt `.SRCINFO` opnieuw met `makepkg --printsrcinfo`. Draait de job als root, dan doet gebruiker `aurbuild` dat (`AUR_MAKEPKG_USER` overschrijft de naam).
14
15De lokale `packaging/arch/PKGBUILD` blijft voor een build uit de werkboom. Die gaat niet naar de AUR.
16
17## Unit en install-hook
18
19De unit is de bestaande system-unit: `User=bluegit`, `ExecStart` met `/etc/bluegit/config.yml`, `StateDirectory=bluegit` voor `/var/lib/bluegit`. Geen `systemd --user`-unit.
20
21`packaging/aur/bluegit.install` draait na installatie en upgrade `systemd-sysusers`, `systemd-tmpfiles --create` en `systemctl daemon-reload`. Hij zet de service niet aan en schrijft `config.yml` niet over. `backup=('etc/bluegit/config.yml')` laat een aangepaste config staan.
22
23## Geheimen
24
25Tim zet deze zelf. De publieke sleutel hoort op aur.archlinux.org, nooit de private sleutel in de repository.
26
27| Naam | Soort | Inhoud |
28| --- | --- | --- |
29| `AUR_SSH_PRIVATE_KEY` | File, mask uit, protected mag | ruwe OpenSSH-sleutel (`BEGIN … PRIVATE KEY`). Een File met base64 wordt ook herkend. |
30| `AUR_SSH_PRIVATE_KEY_B64` | Variable, één regel, Masked+Protected | base64 van die sleutel. GitLab maskeert geen meerregelige waarde, daarom base64 of een File. |
31| `AUR_GIT_AUTHOR_NAME` | Variable | naam in de AUR-commit |
32| `AUR_GIT_AUTHOR_EMAIL` | Variable | e-mail in de AUR-commit |
33
34Eén van de twee sleutelvariabelen is genoeg. `scripts/aur-ssh-setup.sh` haalt CRLF weg en controleert de sleutel met `ssh-keygen -y` zonder hem te printen.
35
36De job heet `publish:aur` in `.gitlab-ci.yml` en `publish_aur` in `blue-ci-cd.yml`. Beide draaien alleen op `master` (BlueGit ook op `main`) en hebben `allow_failure: true`, zodat een storing bij de AUR de rest van de pipeline niet rood maakt.
37
38## Archief moet leesbaar zijn
39
40Een anonieme download van het GitLab-archief gaf 403. De publish-job kan het archief met `CI_JOB_TOKEN` ophalen om de hash te zetten, maar een AUR-gebruiker die `makepkg` draait heeft die token niet. Het project, of in elk geval dat archief-adres, moet publiek leesbaar zijn voordat een installatie vanaf de AUR slaagt.