BlueGit

timfa bluegit

Files

bluegit / docs / CI.md

CI.md

feat: eerste basis van BlueGit
timfa project_87923614_bot_3aff574f6f98414b945a8799374f9092 · pushed by timfa · 3 weeks ago
151aa352 History
CI.md 3.0 KiB Download Raw

blue-ci-cd.yml

Het bestand ligt in de root van de commit die de pipeline start. De vorm lijkt op GitLab CI: stages, jobs, needs en rules. Elke job draait in het image dat erbij staat.

stages: [test, build]
variables:
  CGO_ENABLED: "0"
image: alpine:3.20
jobs:
  test:
    stage: test
    image: golang:1.22
    script:
      - go test ./...
    rules:
      - if: $CI_COMMIT_BRANCH == "main"
      - if: $CI_COMMIT_BRANCH =~ /^release\/.*/
  build:
    stage: build
    needs: [test]
    script:
      - go build -o bluegit ./cmd/bluegit
    artifacts:
      paths: [bluegit]
      expire_in: 14d
    allow_failure: false

Velden

VeldBetekenis
stagesVolgorde. Weggelaten: de stages in de volgorde waarin de jobs ze noemen. Een job zonder stage valt in test.
imageStandaardimage. Een job zonder eigen image gebruikt die.
variablesOmgevingsvariabelen voor elke job. Een job kan ze overschrijven.
jobs.<naam>.scriptNiet-lege lijst. Ze draaien na elkaar in sh, met set -e.
needsJobs die eerst geslaagd of overgeslagen moeten zijn. needs: [] start meteen. Weggelaten: wacht op alle eerdere stages.
rulesDe job draait als minstens één if klopt. Zonder rules draait ze altijd.
artifacts.pathsRelatieve paden, geen ... Na succes bewaard, en in een volgende job gezet die deze job nodig heeft.
artifacts.expire_in30m, 12h, 14d, 2w of never.
allow_failureEen mislukking houdt de rest niet tegen.

Een if is één van:

$NAAM == "waarde"
$NAAM != "waarde"
$NAAM =~ /reguliere-expressie/

Beschikbaar in rules en in de container: CI_COMMIT_SHA, CI_COMMIT_BRANCH, CI_COMMIT_REF, CI_PROJECT_PATH, CI_PIPELINE_ID, CI_JOB_ID, CI_JOB_NAME, CI_JOB_TOKEN, CI_API_URL.

Geheimen

Repositorygeheimen komen als omgevingsvariabele mee. Bij een groepsrepository eerst de groep, daarna de repository; dezelfde naam laat de repository winnen. Een geheim dat als beschermd is gemarkeerd, komt alleen mee als de branch op een beschermd patroon past.

Release vanuit een job

curl -fsS -X POST "$CI_API_URL/repos/$CI_PROJECT_PATH/releases" \
  -H "Authorization: Bearer $CI_JOB_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tag":"v1.2.3","commit":"'"$CI_COMMIT_SHA"'","name":"1.2.3","assets":[{"job":"build","path":"bluegit","name":"bluegit"}]}'

Het commit moet in de repository bestaan. Het asset moet een artifact zijn van een geslaagde job in dezelfde pipeline. Een beheerder kan met een persoonlijk token een release zonder assets maken. Een tag is A-Za-z0-9._-, tot 80 tekens, en wordt ook een annotated git-tag.

Wanneer een job start

Gate in internal/ci geeft ready, wait of skip. skip volgt op een mislukte voorganger zonder allow_failure. De runner verwerkt pipelines elke twee seconden, met ci.concurrency tegelijk (standaard 1, passend bij de mini-PC).

Ontbreekt Docker, dan faalt de job met een regel in het log. De time-out is ci.timeout_seconds (standaard 1800).

Source
1# blue-ci-cd.yml
2
3Het bestand ligt in de root van de commit die de pipeline start. De vorm lijkt op GitLab CI: stages, jobs, needs en rules. Elke job draait in het image dat erbij staat.
4
5```yaml
6stages: [test, build]
7variables:
8 CGO_ENABLED: "0"
9image: alpine:3.20
10jobs:
11 test:
12 stage: test
13 image: golang:1.22
14 script:
15 - go test ./...
16 rules:
17 - if: $CI_COMMIT_BRANCH == "main"
18 - if: $CI_COMMIT_BRANCH =~ /^release\/.*/
19 build:
20 stage: build
21 needs: [test]
22 script:
23 - go build -o bluegit ./cmd/bluegit
24 artifacts:
25 paths: [bluegit]
26 expire_in: 14d
27 allow_failure: false
28```
29
30## Velden
31
32| Veld | Betekenis |
33| --- | --- |
34| `stages` | Volgorde. Weggelaten: de stages in de volgorde waarin de jobs ze noemen. Een job zonder stage valt in `test`. |
35| `image` | Standaardimage. Een job zonder eigen image gebruikt die. |
36| `variables` | Omgevingsvariabelen voor elke job. Een job kan ze overschrijven. |
37| `jobs.<naam>.script` | Niet-lege lijst. Ze draaien na elkaar in `sh`, met `set -e`. |
38| `needs` | Jobs die eerst geslaagd of overgeslagen moeten zijn. `needs: []` start meteen. Weggelaten: wacht op alle eerdere stages. |
39| `rules` | De job draait als minstens één `if` klopt. Zonder rules draait ze altijd. |
40| `artifacts.paths` | Relatieve paden, geen `..`. Na succes bewaard, en in een volgende job gezet die deze job nodig heeft. |
41| `artifacts.expire_in` | `30m`, `12h`, `14d`, `2w` of `never`. |
42| `allow_failure` | Een mislukking houdt de rest niet tegen. |
43
44Een `if` is één van:
45
46```text
47$NAAM == "waarde"
48$NAAM != "waarde"
49$NAAM =~ /reguliere-expressie/
50```
51
52Beschikbaar in rules en in de container: `CI_COMMIT_SHA`, `CI_COMMIT_BRANCH`, `CI_COMMIT_REF`, `CI_PROJECT_PATH`, `CI_PIPELINE_ID`, `CI_JOB_ID`, `CI_JOB_NAME`, `CI_JOB_TOKEN`, `CI_API_URL`.
53
54## Geheimen
55
56Repositorygeheimen komen als omgevingsvariabele mee. Bij een groepsrepository eerst de groep, daarna de repository; dezelfde naam laat de repository winnen. Een geheim dat als beschermd is gemarkeerd, komt alleen mee als de branch op een beschermd patroon past.
57
58## Release vanuit een job
59
60```shell
61curl -fsS -X POST "$CI_API_URL/repos/$CI_PROJECT_PATH/releases" \
62 -H "Authorization: Bearer $CI_JOB_TOKEN" \
63 -H "Content-Type: application/json" \
64 -d '{"tag":"v1.2.3","commit":"'"$CI_COMMIT_SHA"'","name":"1.2.3","assets":[{"job":"build","path":"bluegit","name":"bluegit"}]}'
65```
66
67Het commit moet in de repository bestaan. Het asset moet een artifact zijn van een geslaagde job in dezelfde pipeline. Een beheerder kan met een persoonlijk token een release zonder assets maken. Een tag is `A-Za-z0-9._-`, tot 80 tekens, en wordt ook een annotated git-tag.
68
69## Wanneer een job start
70
71`Gate` in `internal/ci` geeft `ready`, `wait` of `skip`. `skip` volgt op een mislukte voorganger zonder `allow_failure`. De runner verwerkt pipelines elke twee seconden, met `ci.concurrency` tegelijk (standaard 1, passend bij de mini-PC).
72
73Ontbreekt Docker, dan faalt de job met een regel in het log. De time-out is `ci.timeout_seconds` (standaard 1800).