秘密情報を漏らさず環境変数を文書化する方法。
実際の秘密情報を公開せず、設定名、目的、既定値を記録します。必須変数かどうかと読み取り箇所を示してください。
作業手順をタスクに合わせましょう。
変数名とアプリの読み取り箇所を一覧にし、目的、必須性、安全な例を記録します。明示的な既定値と仮定を区別し、実際の秘密の値は文書に入れないでください。
- 用意するもの
- 機密情報を除いた設定名と意図した動作。
- 得られるもの
- 秘密の値を含まない設定リファレンス。
入力と結果を確認しましょう。
説明用の入力と出力 · 実際の WebAct 実行ではない学習用サンプル
入力項目サンプル個
Document APP_PORT (listening port) and SMTP_PASSWORD (mail service credential). Defaults, requiredness and code locations have not been supplied.
完成例
APP_PORT Purpose: port on which the application listens. Example: 3000 (illustrative, not a confirmed default). Default / required / code location: confirm from the application. SMTP_PASSWORD Purpose: credential for the configured mail service. Example value: <set-through-secret-configuration>. Default / required / code location: confirm from the mail integration. Keep the real credential out of shared examples and version control.
この入力をプロンプトに読み込み、WebAct にコピーして試してください。結果は掲載例と異なる場合があります。
判断のポイントとトラブル対処。
秘密設定の文書に動作する認証情報を含めるべきですか？
プレースホルダーを使い、承認された供給方法を説明します。秘密を公開せずに要件を示す文書にしてください。
アプリが使わない既定値がガイドにあるのはなぜですか？
変数を読み取り箇所や提供された設定まで追ってください。名前から推測せず、不明な動作を明示します。
自分の資料で試しましょう。
タスクのプロンプト内の例を自分の資料に置き換えてください。必要な要件を残し、タスクを WebAct にコピーします。
タスクを調整してコピー ↑