Omgevingsvariabelen documenteren zonder geheimen te lekken.
Documenteer namen, doel en standaardwaarden zonder echte geheimen bloot te leggen. Geef aan of een variabele verplicht is en waar die wordt gelezen.
Stem de werkwijze af op je taak.
Inventariseer variabelenamen en leesplekken in de applicatie met doel, verplichtheid en veilige voorbeelden. Onderscheid een expliciete standaardwaarde van een aanname en houd echte geheimen uit de documentatie.
- Wat je aanlevert
- Opgeschoonde configuratienamen en bedoeld gedrag.
- Wat je krijgt
- Configuratiereferentie zonder geheime waarden.
Bekijk de invoer en het resultaat.
Illustratieve invoer en uitvoer · een leervoorbeeld, geen live uitvoering van WebAct
Voorbeeld invoerveld
Document APP_PORT (listening port) and SMTP_PASSWORD (mail service credential). Defaults, requiredness and code locations have not been supplied.
Uitgewerkt voorbeeld
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.
Laad deze invoer in de prompt en kopieer deze naar WebAct om de taak te proberen. Je resultaat kan afwijken van het voorbeeld.
Keuzes en probleemoplossing.
Moet documentatie over geheime configuratie werkende inloggegevens bevatten?
Gebruik een placeholder en leg de goedgekeurde aanlevermethode uit. De documentatie moet de eis benoemen zonder het geheim bloot te leggen.
Waarom beschrijft de gids een standaardwaarde die de applicatie niet gebruikt?
Volg de variabele naar de leesplek of aangeleverde configuratie. Markeer onbekend gedrag in plaats van te gokken vanuit de naam.
Probeer het met je eigen bron.
Vervang het voorbeeld door je eigen materiaal in de taakprompt. Behoud de eisen die je nodig hebt en kopieer de taak naar WebAct.
De taak aanpassen en kopiëren ↑