Files
gitea-ci-library/docs/adr/0005-provider-consumer.md
T
niko bd6ed5c2c2
CI Gitea Reports Main / Config load (push) Successful in 17s
CI Main / Config load (push) Successful in 20s
CI Gitea Reports Main / Latest version (push) Successful in 17s
CI Main / Latest versio (push) Successful in 19s
ci-helm-build-push Helm push 0.2.0
CI Gitea Reports Main / Build & Push Helm chart (push) Successful in 33s
gitops/gitea-ci-library/gitea-reports GitOps: gitea-reports 0.2.0
CI Gitea Reports Main / GitOps (push) Successful in 33s
CI Gitea Reports Main / Report Summary (push) Successful in 3s
CI Main / Bats tests (push) Failing after 1m16s
CI Main / Cucumber tests (push) Failing after 1m22s
CI Main / Build & Push Docker (push) Has been skipped
CI Main / GitOps (push) Has been skipped
CI Main / Move provider version tag (push) Has been skipped
CI Main / Report Summary (push) Successful in 3s
Feature/git pages -> oma nginx perusteinen raporointipalvelu (#48)
Co-authored-by: moilanik <niko.moilanen@tietoevry.com>
Reviewed-on: #48
2026-06-28 09:10:10 +03:00

2.4 KiB

5. Provider & Consumer -malli

Päätös

Provider (gitea-ci-library) ja Consumer (mikropalveluprojekti) erotetaan selkeällä rajapinnalla: .gitea/workflows/build-feature.yml on ainoa pinta, jota consumer kutsuu.

Kaikki muu providerin koodi (scriptit, git-pages-helmi, retention) on sisäistä toteutusta, johon consumerilla ei ole suoraa pääsyä eikä riippuvuutta.

Rajapinnat

Consumer → Provider (pakollinen)

# .gitea/workflows/ci.yml — consumerin repo
jobs:
  ci:
    uses: niko/gitea-ci-library/.gitea/workflows/build-feature.yml@v1
    secrets: inherit

Consumer:

  • Omistaa pipeline-logiikan (mitä testejä ajetaan, missä järjestyksessä)
  • Luo raportit omiin polkuihinsa (reports/{sha8}/{step}/)
  • Luo .meta-tiedostot per step
  • Määrittelee Gitea-secretit (REPORTS_PUBLISH_TOKEN, GITEA_TOKEN)

Provider → Consumer (mitä provider tarjoaa)

  • Raporttien julkaisu: consumerin tuottamat raportit viedään git-pages-palveluun osoitteeseen, josta ne ovat selaimella luettavissa.
  • Commit-status linkillä: jokaiselle raportille luodaan commit-status, jonka kautta käyttäjä pääsee suoraan raporttiin Gitean commit-näkymästä.
  • Orkestrointi: build-ketjun ylittäessä reporajat, provider huolehtii workflown käynnistyksestä ja tilan seurannasta.
  • Raporttien elinkaari: vanhat raportit poistetaan automaattisesti retention-sääntöjen mukaan.

Provider (sisäinen toteutus, ei consumerin rajapinta)

  • Git-pages Helm-chartti
  • Retention sidecar
  • Scriptit ja työkalut (toteutus avoin, uudelleenkirjoitettavissa)
  • Kaikki paitsi build-feature.yml on sisäistä toteutusta ja voi muuttua ilman versiopäivitystä

Periaatteet

  1. build-feature.yml on lukittu rajapinta. Consumer kutsuu tätä, ei koskaan providerin scriptejä suoraan. build-feature.yml voi muuttua vain version vaihtuessa.
  2. Consumer omistaa pipeline-logiikan. Provider ei tiedä mitä testejä ajetaan, missä järjestyksessä tai millä työkaluilla.
  3. Providerin versiointi: tag (v1, v2, ...). Branchit ovat kehitystä varten, consumerit käyttävät tageja.

Tausta

Jenkins-versiossa kaikki logiikka oli yhdessä kirjastossa. Gitea Actionsin reusable workflow -mekanismi pakottaa selkeämpään erotteluun: consumer kutsuu provideria, mutta omistaa oman pipeline-logiikkansa. Tämä vähentää providerin kompleksisuutta ja antaa consumerille vapauden päättää mitä ajetaan.