adding-env-variables

Guide for adding new environment variables to the codebase. Ensures env.ts schemas include descriptions and .env.example is kept in sync. Triggers on: add env variable, new environment variable, env.ts change, add config variable, INKEEP_, adding to .env.

1. Przed dodaniem nowej zmiennej środowiskowej uruchom lokalnie skrypt walidacji: pnpm check:env-descriptions, aby sprawdzić bieżący stan dokumentacji zmiennych w projekcie.

2. Otwórz plik .env.example w głównym katalogu repozytorium i dodaj nową zmienną w odpowiedniej sekcji (np. AI PROVIDERS, DATABASE, itd.) z komentarzem opisującym jej przeznaczenie i gdzie uzyskać wymaganą wartość.

3. Zlokalizuj odpowiedni plik env.ts dla swojego pakietu (agents-api/src/env.ts dla API, packages/agents-core/src/env.ts dla konfiguracji wspólnej lub agents-cli/src/env.ts dla narzędzia CLI) i dodaj zmienną z obowiązkowym wywołaniem .describe() zawierającym opis.

4. Upewnij się, że nazwa zmiennej, jej opis i wartość domyślna są spójne między plikami .env.example i env.ts.

5. Uruchom ponownie skrypt check:env-descriptions, aby potwierdzić, że nowa zmienna przeszła walidację i nie ma brakujących opisów.

6. Wyślij zmiany do repozytorium — CI automatycznie sprawdzi, czy wszystkie zmienne w env.ts mają prawidłowe opisy, i odrzuci pull request, jeśli walidacja się nie powiedzie.