adding-env-variables
Poradnik do dodawania zmiennych środowiskowych z automatyczną walidacją i synchronizacją dokumentacji
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Umiejętność wspierająca dodawanie nowych zmiennych środowiskowych do projektu. Zapewnia, że wszystkie zmienne w plikach env.ts zawierają opisy, a plik .env.example pozostaje zsynchronizowany z kodem. Automatycznie uruchamia się przy zmianach w konfiguracji, dodawaniu zmiennych INKEEP_ lub edycji plików env.ts. Obejmuje wbudowaną walidację CI, która wymusza dokumentowanie każdej zmiennej środowiskowej.
Jak używać
Przed dodaniem nowej zmiennej środowiskowej uruchom lokalnie skrypt walidacji: pnpm check:env-descriptions, aby sprawdzić bieżący stan dokumentacji zmiennych w projekcie.
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ść.
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.
Upewnij się, że nazwa zmiennej, jej opis i wartość domyślna są spójne między plikami .env.example i env.ts.
Uruchom ponownie skrypt check:env-descriptions, aby potwierdzić, że nowa zmienna przeszła walidację i nie ma brakujących opisów.
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.