Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

クローズ
#184 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
22/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
docker, github-actions, gitlab, helm, kubernetes, nuxt, php, postgresql, symfony

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Vue
スター
0
フォーク
0
平均マージ
1時間 20分
マージ済み PR(30日)
1

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

components-web-app/docs のほかの issue

components-web-app/docs の issue をすべて見る

似ている issue

DevOps の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。