katanaSecretsYamlCode function

String katanaSecretsYamlCode()

Contents of katana_secrets.yaml.

katana_secrets.yamlの中身。

Implementation

String katanaSecretsYamlCode() => """
# Values can reference environment variables with `\${NAME}` (`\${NAME:-default}` for a default, `\$\${NAME}` to keep it literally).
# 値には`\${NAME}`で環境変数を参照できます（`\${NAME:-default}`でデフォルト値、`\$\${NAME}`でそのまま記載）。

# Describe Cloudflare secret information.
# Cloudflareのシークレット情報を記述します。
cloudflare:
  # Cloudflare API token used by `katana apply` (e.g. Pages custom domains).
  # Required permissions: `Account > Cloudflare Pages > Edit`, and
  # `Zone > Zone > Read` / `Zone > DNS > Edit` to create the CNAME record.
  # If empty, `CLOUDFLARE_API_TOKEN` or `wrangler auth token` is used.
  # `katana apply`が使用するCloudflare APIトークン（Pagesのカスタムドメインなど）。
  # 必要な権限：`Account > Cloudflare Pages > Edit`、CNAMEレコードの作成には
  # `Zone > Zone > Read`・`Zone > DNS > Edit`。
  # 空の場合は`CLOUDFLARE_API_TOKEN`または`wrangler auth token`を使用します。
  api_token:

  authentication:
    delete_user:
      # Firebase Admin SDK service account JSON used by the delete-user Worker.
      # delete-user Workerが使用するFirebase Admin SDKサービスアカウントJSON。
      service_account:

  turso:
    # Turso Platform API Token. This non-empty value takes precedence over `katana.yaml`.
    # TursoのPlatform API Token。空でない場合は`katana.yaml`より優先されます。
    platform_api_token:

  tidb:
    # TiDB Cloud API key used only by `katana apply` to create SQL users
    # when [cloudflare]->[tidb]->[migration_auth] is `api_key`.
    # Environment variables TIDBCLOUD_PUBLIC_KEY / TIDBCLOUD_PRIVATE_KEY take precedence.
    # [cloudflare]->[tidb]->[migration_auth]が`api_key`の場合に`katana apply`がSQL user作成へ利用するTiDB Cloud APIキー。
    # 環境変数TIDBCLOUD_PUBLIC_KEY / TIDBCLOUD_PRIVATE_KEYが優先されます。
    public_key:
    private_key:

# Describe purchase secret information.
# 課金のシークレット情報を記述します。
purchase:
  app_store:
    # App Store shared secret. This non-empty value takes precedence over `katana.yaml`.
    # App Store共有シークレット。空でない場合は`katana.yaml`より優先されます。
    shared_secret:

# Describe Github secret information.
# Githubのシークレット情報を記述します。
github:
  # Please describe the Github token.
  # Githubのトークンを記載してください。
  token:

  slack:
    # Slackに通知を送ります。
    # 下記の手順で設定を行います。
    # 1. Slack の「App」にGitHubを追加する
    #    https://developer.mamezou-tech.com/blogs/2022/12/12/notify-github-actions-workflow-to-slack/
    # 2. Slack の「 Incoming Webhook」 を利用
    #    https://w1625424953-rox450381.slack.com/apps/A0F7XDUAZ--incoming-webhook-?tab=more_info
    #
    incoming_webhook_url:

# Describe OpenAI secret information.
# OpenAIのシークレット情報を記述します。
openai:
  api_key:
""";