Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Template 2.0.0-alpha.16: CWA_CI_ variable renames, NUXT_/CWA_API_ site settings, in-cluster PostgreSQL

Cerrado
  • ¿Algo no está bien?
#184 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
22/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
docker, github-actions, gitlab, helm, kubernetes, nuxt, php, postgresql, symfony
Área
ci-cd, devops, documentation

Línea de trabajo

Start with the changelog rename table linked from the issue, then find every page that names a deploy or CI variable, beginning with 7.upgrading-the-template.md, 3.ci-cd.md and kubernetes.md. Update the names and add the new CWA_CI_, NUXT_ and CWA_API_ sections, and confirm each claim against the template's changelog. Done when no old variable name remains in the docs and the upgrade guide carries the full rename table.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

The template's 2.0.0-alpha.16 (see its CHANGELOG) changes how deploys are configured. Pages to update:

1. CI variable renames (no fallback: the old names are no longer read)

  • Every page that names a deploy or CI variable (switches, sizing, TLS, fixtures, warm cache, Lighthouse audit, orphan scan, ingress limits) should use the CWA_CI_* names, and the upgrade guide (7.upgrading-the-template.md) should carry the rename table from the changelog.
  • The ones that matter most: POSTGRESQL_ENABLED → CWA_CI_POSTGRES_ENABLED, CLUSTER_ISSUER → CWA_CI_CLUSTER_ISSUER, ENABLE_DATABASE_FIXTURES → CWA_CI_FIXTURES_ENABLED, LETSENCRYPT_SECRET_NAME → CWA_CI_TLS_SECRET_NAME, KUBE_INGRESS_WWW_REDIRECT → CWA_CI_WWW_REDIRECT. On GitHub, CI_DISABLED → CWA_CI_DISABLED.
  • Site values, secrets and platform names keep their names: DATABASE_URL, POSTGRES_*, JWT_*, MAILER_*, GCLOUD_*, KUBE_INGRESS_BASE_DOMAIN, CI_*.

2. Site settings through CI variables (3.ci-cd.md, new section)

  • PWA: any NUXT_* CI variable reaches the PWA unchanged. NUXT_PUBLIC_* goes in a ConfigMap; any other NUXT_* goes in a Secret. Set them the way you would for any Nuxt deployment.
  • API: CWA_API_<NAME> reaches the API (and the orphan-scan CronJob) as <NAME>, always as a Secret. An empty CWA_API_ value is left out, so Caddy's and Symfony's defaults still apply; an empty NUXT_* is still delivered.
  • Nothing is baked into images. Site settings are runtime env vars (runtimeConfig / %env()%), never Docker build args.
  • The deploy refuses names the chart sets itself (NUXT_CWA_API_URL, NUXT_PUBLIC_CWA_API_URL_BROWSER, NUXT_PUBLIC_CWA_ENVIRONMENT, DATABASE_URL, …).
  • On GitHub, secrets named NUXT_* or CWA_API_* are exported to the deploy steps automatically (github-export-secrets.sh).
  • CWA_ENVIRONMENT (API) and NUXT_PUBLIC_CWA_ENVIRONMENT (PWA) name the environment: production, staging, canary or review.

3. Origin protection, rate limits, Cloudflare purge pacing
These pages should say that deploys set the settings as CWA_API_<NAME>: CWA_API_RATE_LIMIT_EVENTS, CWA_API_CACHE_QUERY_ALLOWLIST, CWA_API_CLOUDFLARE_PURGE_PLAN, CWA_API_CADDY_TRUSTED_PROXIES, etc. Local compose keeps the bare names.

4. In-cluster PostgreSQL (kubernetes.md)

  • POSTGRES_USER, POSTGRES_PASSWORD and POSTGRES_DB now take effect. They used to be ignored; it always ran as example / !ChangeMe! / api. POSTGRES_USERNAME is gone. Recommend setting a real password.
  • It isn't persistent by default: data is lost when its pod restarts. Use an external database for anything real. Optional persistence: CWA_CI_POSTGRES_PERSISTENCE, CWA_CI_POSTGRES_PERSISTENCE_SIZE, CWA_CI_POSTGRES_STORAGE_CLASS. Turning it on, or changing it on a live release, stops the deploy with the commands to run. Review cleanup deletes the review volume. Changing credentials on a persistent database needs the change made in PostgreSQL first.
  • KUBERNETES_VERSION / HELM_VERSION can be set as CI variables on GitLab too.

5. Optional (#127)
The installation page's file tree (around lines 113–115) lists AppScaffold.php and Parts/; these exist only when fixtures were chosen.

Cloudflare per-track rules are in #181.

Lenguaje dominante
TypeScript
Estrellas
0
Forks
0
Merge medio
1 h 20 min
PR fusionados (30 d)
1

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de components-web-app/docs

Todos los issues de components-web-app/docs

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.