Skip to content

Commit 92e0450

Browse files
committed
docs: add deployment instructions and requirements to README
1 parent 126ed29 commit 92e0450

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

README.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,64 @@ Om een blog te publiceren die in draft staat volg je de volgende stappen:
6060
- Verplaats de blogpost naar de map van de huidige maand.
6161
- Verwijder de `draft: true` property uit het frontmatter van de blogpost.
6262
- Draai `pnpm build` om te kijken of de markdown in orde is.
63+
64+
## Deployen
65+
66+
De deployment van deze site verloopt via GitHub Actions en een aparte infra
67+
repository.
68+
69+
### Benodigde variabelen en secrets
70+
71+
- Organization variable `INFRA_REPO`, bijvoorbeeld
72+
`developer-overheid-nl/don-infra`.
73+
- Repository variable `KUSTOMIZE_PATH`, met als basispad bijvoorbeeld
74+
`apps/frontend/overlays/`.
75+
- Secrets `RELEASE_PROCES_APP_ID` en `RELEASE_PROCES_APP_PRIVATE_KEY` voor het
76+
aanpassen van de infra repository.
77+
- Secrets `PIWIK_PRO_ACCOUNT_ADDRESS` en `PIWIK_PRO_SITE_ID` voor de build.
78+
79+
### Deploy naar test
80+
81+
De testdeploy draait via
82+
`.github/workflows/deploy-test.yml`.
83+
84+
- De workflow draait op pushes naar branches behalve `main`.
85+
- Alleen commits met `[deploy-test]` in de commit message worden echt gedeployed.
86+
- Er wordt een image gebouwd en gepusht naar
87+
`ghcr.io/<owner>/<repo>` met tags `test` en de commit SHA.
88+
- Daarna wordt in `INFRA_REPO` het bestand
89+
`${KUSTOMIZE_PATH}test/kustomization.yaml` bijgewerkt naar de nieuwe image
90+
tag en direct gecommit.
91+
92+
Voorbeeld commit message:
93+
94+
```text
95+
feat: pas content aan [deploy-test]
96+
```
97+
98+
### Contributies en deploy
99+
100+
Een contribution of pull request leidt niet automatisch tot een deployment.
101+
102+
- Een pull request triggert wel CI, waaronder de build en JSON-validatie.
103+
- De build in `.github/workflows/build.yml` bouwt voor een pull request een
104+
Docker image als controle, maar pusht dat image niet naar GHCR en past de
105+
infra repository niet aan.
106+
- Er is dus geen automatische preview-omgeving per pull request.
107+
- Een testdeploy gebeurt pas na een push naar een branch in deze repository met
108+
`[deploy-test]` in de commit message.
109+
- Die testdeploy gebruikt repository- en organization-variables en secrets om
110+
ook `INFRA_REPO` aan te passen. Daardoor is dit pad in de praktijk bedoeld
111+
voor maintainers of contributors met een branch in deze repository.
112+
113+
### Deploy naar productie
114+
115+
De productiedeploy draait via
116+
`.github/workflows/deploy-prod.yml`.
117+
118+
- De workflow draait bij een push naar `main`.
119+
- Er wordt in `INFRA_REPO` een release branch aangemaakt.
120+
- In `${KUSTOMIZE_PATH}prod/kustomization.yaml` wordt de image tag bijgewerkt
121+
naar de commit SHA van deze repository.
122+
- Daarna wordt automatisch een pull request in de infra repository geopend.
123+
- De productie-uitrol gebeurt door die pull request te mergen.

0 commit comments

Comments
 (0)