Files
AndreaSlopFotografie/aidlc-docs/features/frontend-shell/operations/plans/deployment-setup-plan.md
T
SluijsensandClaude Opus 5.5 e6436601a4
Continuous Integration / check (pull_request) Failing after 6m55s
Continuous Integration / lighthouse (pull_request) Skipped
Continuous Integration / deploy-test (pull_request) Skipped
Continuous Integration / deploy-production (pull_request) Skipped
Adds Gitea Actions CI/CD for test and production
The pipeline runs lint, format, tests, build, dependency audit and
Lighthouse (mobile and desktop, Playwright Chromium on the arm64 runner)
on every pull request, push to master and manual run.

Pushes to master deploy to test automatically, and any branch can be
deployed to test manually. Test is a Raspberry Pi with nginx next to the
current WordPress site; the deploy refuses folders containing WordPress.
Production deploys are manual and only from release/* branches, over
FTP with TLS to the IIS webhost.

The IIS web.config and both nginx configs are generated from the same
security header list as the Vite servers, with a test that fails when
the generated files drift. Adds .gitattributes for LF line endings and
pins pnpm through packageManager.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-19 00:18:51 +02:00

109 lines
6.4 KiB
Markdown

# Deployment Setup Plan — frontend-shell
## Context
- **Code**: `web/` (static SPA). `pnpm build` produces `dist/`. `pnpm check` runs lint, format, tests, build, audit and Lighthouse.
- **Git hosting**: self-hosted Gitea at `gitea.slpsoftware.nl`. There is no CI configuration yet (`.gitea/workflows` and `.github` do not exist).
- **Back-end**: `api/` exists but is empty; the .NET API comes later.
- **Carried-forward requirements**:
- `pnpm check` runs on every push (NFR follow-up 1).
- The production host sends the security headers (NFR-SEC-01/02).
- The SPA fallback: every unknown path serves `index.html`, so deep links like `/portfolio` work.
## Plan
- [x] 1. Answer the questions below
- [x] 2. Analyze answers (follow-up questions if needed)
- [x] 3. Generate `operations/deployment/deployment-plan.md`
- [x] 4. Generate the pipeline definition(s) in the repository, plus `operations/deployment/deployment-instructions.md`
- [x] 5. Generate `operations/deployment/rollback-plan.md`
- [x] 6. Fix line endings (see below) and verify the pipeline steps locally
## Already decided (no question needed)
- **Line endings**: a `.gitattributes` with `* text=auto eol=lf` (binary files excepted).
- Today Git converts files to Windows line endings (CRLF) on checkout, while Prettier requires LF. A fresh checkout on Windows can therefore fail `pnpm check`, and the CI runner and your machine would see different files.
- Your editor keeps working as before; files are simply stored and checked out with LF everywhere.
- **Pipeline order**: install with the lockfile, then `pnpm check`. Deployment only happens when that passes.
- **Secrets**: deployment credentials go in Gitea's encrypted Actions secrets, never in the repository.
---
## Questions
Vul per vraag de letter in na `[Answer]:`. Past geen enkele optie, kies dan de laatste (Anders) en licht toe. Waar ik een voorkeur heb staat **(aanbevolen)**.
### Vraag 1: Deployment opzetten voor deze feature?
A) Ja, help me deployment op te zetten
B) Nee, deployment gebeurt elders of is niet nodig
C) Weet ik niet, stel een aanpak voor en ik beslis
X) Anders (beschrijf hieronder na de [Answer]:-tag)
[Answer]: A
### Vraag 2: Welk CI-systeem?
Gitea heeft een ingebouwd CI-systeem, **Gitea Actions**, met dezelfde workflow-syntax als GitHub Actions. Het heeft wel een **runner** nodig: een klein programma (`act_runner`) op een server, dat de jobs uitvoert.
A) Gitea Actions **(aanbevolen)** Zit in je Gitea, geen extra dienst, en de workflows zijn later eenvoudig naar GitHub over te zetten.
B) Een aparte CI-dienst (bv. Woodpecker, Jenkins)
X) Anders (beschrijf hieronder na de [Answer]:-tag)
[Answer]: A
### Vraag 3: Is er al een runner voor Gitea Actions?
A) Ja, er draait al een runner die ik voor dit project kan gebruiken
B) Nee. Neem in de instructies op hoe ik er een opzet (met Docker op een eigen server of pc) **(aanbevolen als er nog geen is)**
C) Weet ik niet, ik controleer het
X) Anders (beschrijf hieronder na de [Answer]:-tag)
[Answer]: A
### Vraag 4: Waar wordt de website gehost?
A) Op een eigen server (bv. dezelfde als Gitea), met een webserver zoals Caddy of nginx. De pipeline zet de bestanden er via SSH/rsync neer. Volledige controle over security headers en de SPA-fallback. **(aanbevolen als je een eigen server hebt)**
B) Bij een webhoster met FTP/SFTP-toegang, bijvoorbeeld waar de huidige statische site staat. Headers en fallback dan via `.htaccess` (Apache), als de hoster dat toestaat.
C) Een static-hostingdienst (bv. Cloudflare Pages, Netlify, of een Europese variant). Weinig beheer, headers via een configbestand.
D) Nog niet bekend: zet nu alleen de CI op (bouwen en testen bij elke push) en de deployment later
X) Anders (beschrijf hieronder na de [Answer]:-tag)
[Answer]: X, voor productie wordt dat een webhoster met ftp/sftp toegang. Voor de testomgeving heb ik een eigen server, maar heb ik eventueel ook toegang met ftp/sftp. Ik heb alleen maar 1 website die ik kan hosten dus zodra ik de API ga bouwen die uit een ander project gaat komen moet de website als static files worden geserveerd door de API. Dit is een pagina met meer info over de webhost: https://www.mijnhostingpartner.nl/pg/info/aspnet-core-hosting/ en het gaat dan om het ASP.NET Core 10 Hosting pakket
### Vraag 5: Welke omgevingen?
A) Alleen productie
B) Test/staging (bv. `test.andreaslop.nl`) en productie. Je ziet een wijziging eerst op test voordat hij live gaat. **(aanbevolen)**
C) Ook een preview per pull request
X) Anders (beschrijf hieronder na de [Answer]:-tag)
[Answer]: B
### Vraag 6: Wanneer wordt er gedeployd?
A) Automatisch: elke merge naar `master` gaat live (en, bij een testomgeving, elke push naar een feature-branch naar test)
B) Automatisch naar test; naar productie pas na een handmatige goedkeuring of start in Gitea **(aanbevolen)**
C) Altijd handmatig starten
X) Anders (beschrijf hieronder na de [Answer]:-tag)
[Answer]: B, ik wil de gitflow gaan toepassen. Naar test moet altijd kunnen. Zodat er makkelijk en snel een specifieke versie op de test-omgeving gedeployed of geredeployed kan worden. Naar productie mag alleen vanaf een release-branch. DIe branch wordt daarna teruggemerged naar develop en master en op master wordt dan een tag gezet. Ik heb ook van trunk-based gehoord. het zou kunnen dat dat praktischer is. Ik laat mij graag aanbevelen wat handiger is voor mij.
### Vraag 7: Lighthouse in de pipeline
`pnpm check` draait ook Lighthouse, en daarvoor moet er Chrome in de runner zitten. Dat maakt de pipeline een paar minuten langer.
A) Ja, de volledige `pnpm check`, inclusief Lighthouse, in de pipeline. De runner gebruikt een image met Chrome. **(aanbevolen)** Dit was jouw wens: een vergeten lokale check wordt dan alsnog opgevangen.
B) In de pipeline alles behalve Lighthouse; Lighthouse alleen lokaal
X) Anders (beschrijf hieronder na de [Answer]:-tag)
[Answer]: ik heb een headless browser op de gitea/buildserver staan. Als het goed is is dat chrome, maar niet meer helemaal zeker.
### Vraag 8: Terugdraaien bij een mislukte release
A) De server bewaart de laatste paar releases. Terugdraaien is één commando of één klik in Gitea, die terugwisselt naar de vorige release. **(aanbevolen bij een eigen server)**
B) Terugdraaien door de vorige commit opnieuw door de pipeline te laten deployen
X) Anders (beschrijf hieronder na de [Answer]:-tag)
[Answer]: B als dat kan en ook gezien de database. Ik weet niet of er via de pipeline een migratie kan worden gedaan en ook terug worden gedraaid zodra we een API hebben?