Continuous Integration / check (pull_request) Successful in 2m25s
Continuous Integration / build-test (pull_request) Skipped
Continuous Integration / deploy-test (pull_request) Skipped
Continuous Integration / lighthouse (pull_request) Successful in 9m2s
Continuous Integration / deploy-production (pull_request) Skipped
The form is closed unless the build sets VITE_CONTACT_FORM_ENABLED=true (only
the test build does), so d449e76 no longer has to be undone before the merge.
Status files of contact-form-cms, asf-packages-cms, asf-cms-host-injection and
asf-translation-files are closed; Build and Test summary added.
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
51 lines
6.7 KiB
Markdown
51 lines
6.7 KiB
Markdown
# Deploy and CI
|
|
|
|
Pipeline: [.gitea/workflows/continuous_integration.yaml](../.gitea/workflows/continuous_integration.yaml). Branch strategy and rollback are in `aidlc-docs/features/frontend-shell/operations/deployment/` and `aidlc-docs/features/prerendering/`.
|
|
|
|
## Triggers
|
|
|
|
| Trigger | Result |
|
|
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| Pull request | Checks only, no deploy. |
|
|
| Push to `master` | Checks, then deploy to test. |
|
|
| Every night, 03:15 UTC (`schedule`) | Test build with the packages and banners from the test CMS, deploy to test, no Lighthouse. Gitea runs schedules only from the default branch, so this works after the packages feature is merged to `master`. Never production. |
|
|
| Manual (`workflow_dispatch`), any branch | Checks, and a deploy to test if `deploy_test` is on. |
|
|
| Manual from a `release/*` branch | Deploy to production if `deploy_production` is on. |
|
|
|
|
## Workflow inputs
|
|
|
|
- `deploy_test` (boolean, default false): "Deploy to Test". Builds the test artifact and deploys it to ASF test.
|
|
- `deploy_production` (boolean, default false): "Deploy to Production". Only works from a `release/*` branch and only with Bryan's explicit go.
|
|
|
|
Dispatch from the CLI (the token comes from your git credentials, never print it): `POST /api/v1/repos/SLP_Software/AndreaSlopFotografie/actions/workflows/continuous_integration.yaml/dispatches` with `{"ref": "<branch>", "inputs": {"deploy_test": "true"}}`.
|
|
|
|
## Jobs
|
|
|
|
1. `check`: lint, format, unit/property/axe tests (coverage threshold 100% on `src/lib/**`), build **without** `OFFERINGS_URL` (so with the committed snapshot), audit. Uploads artifact `dist` (this is what production gets).
|
|
2. `build-test`: builds again with `OFFERINGS_URL=${{ vars.ASF_OFFERINGS_URL_TEST }}` (packages and banners from the test CMS) and `VITE_SITE_URL=https://test.andreaslop.nl` (see "Own address of the test site") and uploads `dist-test`.
|
|
3. `deploy-test`: needs `check` and `build-test`, downloads `dist-test`, uploads to the ASF test host and runs the deployment check (served by the CMS host, admin files, POST status).
|
|
4. `lighthouse`: against the built site with the preview stub (`--audit-route --contact-stub`); skipped on `schedule`.
|
|
5. `deploy-production`: manual, from `release/*` only, uses artifact `dist`.
|
|
|
|
There is one Raspberry Pi runner plus a desktop runner, so jobs can wait in the queue for a long time (for example 30 minutes before `build-test`); a deploy that only just started is not hung. Check `started_at` (UTC) before cancelling anything.
|
|
|
|
## Deploying a feature branch to test
|
|
|
|
Committing, pushing and deploying a feature branch to test is allowed for the sessions that work on it. Merging, deploying to production and changing repo variables are not (Bryan decides). After a test deploy, check the page in a real browser against the real test CMS; `web/e2e/` holds the checks that run in CI.
|
|
|
|
## Contact form switch (`VITE_CONTACT_FORM_ENABLED`)
|
|
|
|
The contact form is closed by default. Only the test build (`build-test`) sets `VITE_CONTACT_FORM_ENABLED=true`, so the ASF test host shows the real form; the production artifact (job `check`) is built without it and stays closed. Only the exact value `true` opens the form (`src/lib/contactFormFlag.ts`); anything else keeps it closed, so a typo cannot open it in production. This replaced the former TEST ONLY commit `d449e76` (which hard-coded `enabled: true`); it was reverted before the merge, so nothing has to be undone any more. Opening the form in production needs Bryan's explicit go after the captcha decision (see [go-live-checklist.md](go-live-checklist.md)). Locally: `VITE_CONTACT_FORM_ENABLED=true pnpm build`.
|
|
|
|
## The check after a deploy and the host injection
|
|
|
|
`deploy/verify-deployment.sh` compares what the server sends with the files in `dist`. Once the CMS host injects (packages, banners, prices, JSON-LD price, site address), the pages differ from `dist` by design, so both sides are first normalised with `config/normalizeInjected.ts` (the contents of the CMS regions, the data block, `offers` in structured data, inline prices and the site address are taken out). Everything else must still be equal byte for byte, so an old build or a wrong server config is still caught; the 404 page is not injected and is compared as it is. The preview server can stand in for the host (`node config/previewServer.ts --cms-data=<json>`), which is how the script is tried locally.
|
|
|
|
## Own address of the test site
|
|
|
|
The test site stands on its own: in the test build `VITE_SITE_URL` is `https://test.andreaslop.nl`, so canonical, `og:url`, `og:image`, the JSON-LD ids and urls and `sitemap.xml` all point to the test host. A link shared from the test site (WhatsApp, Discord) therefore shows its own picture, not one from production. The production artifact (job `check`) is built without the variable and keeps `https://andreaslop.nl`. `src/lib/siteUrl.ts` only accepts an origin (https, or http on localhost); anything else falls back to production, so a typo cannot move production to another domain. This is a build setting, not TEST ONLY code: nothing has to be reverted before a merge. `robots.txt` on the test host is the nginx one (`Disallow: /`, plus `X-Robots-Tag: noindex`), not `public/robots.txt`, so the test site stays out of search engines. To try it locally: `VITE_SITE_URL=http://localhost:4173 pnpm build`.
|
|
|
|
## Generated files
|
|
|
|
`web/deploy/iis/web.config` and `web/deploy/nginx/*.conf` are generated by `pnpm server-config` from `web/config/serverConfig.ts`. Change the generator, rerun it and commit the result; a test checks that they match.
|