Generator CODEOWNERS
Automatyczne kierowanie zmian do właściwych recenzentów
-
1Wprowadź dane
Wpisz treść, wklej tekst lub załaduj plik z dysku. -
2Kliknij przycisk
Narzędzie natychmiast przetworzy Twoje dane w przeglądarce. -
3Pobierz wynik
Skopiuj gotowy tekst lub zapisz plik na urządzeniu.
return "Wynik gotowy w 0.1s";
}
Każda niepusta linia musi zawierać wzorzec i co najmniej jednego właściciela.
Umieść plik w katalogu .github/, w katalogu głównym albo w docs/. Ostatnia pasująca reguła wygrywa.
Oceń to narzędzie:
Powiązane narzędzia
Inne narzędzia, które mogą Ci się przydaćGenerator pliku CODEOWNERS dla GitHuba
Generator CODEOWNERS tworzy reguły przypisujące użytkowników lub zespoły do ścieżek w repozytorium. Gdy Pull Request zmienia pasujący plik, GitHub może automatycznie poprosić właściwe osoby o recenzję.
Wpisz jedną regułę w każdej linii: najpierw wzorzec, a po nim właściciela. Narzędzie zachowuje kolejność, sprawdza format kont i odrzuca konstrukcje nieobsługiwane przez CODEOWNERS. Wynik i dane formularza przetwarza serwer webp.pl; nie są wysyłane do GitHuba.
Jak wygenerować reguły?
- Wybierz preset Frontend, Backend lub Monorepo albo wpisz własne wzorce.
- Po wzorcu podaj konto
@użytkownik, zespół@organizacja/zespółlub adres e-mail powiązany z kontem. - Ustaw właściciela domyślnego. Generator doda regułę
*, jeśli nie ma jej już w tekście. - Umieść reguły ogólne wyżej, a bardziej szczegółowe niżej, ponieważ ostatnia pasująca reguła wygrywa.
- Skopiuj wynik do pliku o nazwie dokładnie
CODEOWNERSi zatwierdź go w repozytorium.
Reguły własności warto przeglądać razem ze zmianami procesu CI. Konfigurację automatycznych testów przygotuje generator GitHub Actions, a pliki pomijane przez Git można uporządkować za pomocą generatora .gitignore.
Składnia CODEOWNERS i kolejność dopasowania
Wzorce, właściciele i przykłady
| Reguła | Znaczenie |
|---|---|
* @maintainers | Domyślny właściciel każdego pliku bez późniejszej, dokładniejszej reguły |
*.js @frontend-team | Pliki JavaScript w repozytorium |
/docs/ @docs-team | Dokumentacja w katalogu położonym w korzeniu |
/api/ @backend-team @api-lead | Dwie grupy właścicieli dla zmian API |
apps/web/ @org/frontend | Zespół organizacji odpowiedzialny za część monorepo |
Generator nie usuwa powtarzających się wzorców. To celowe: w CODEOWNERS ostatnia pasująca reguła określa właścicieli, więc usunięcie późniejszego wpisu zmieniłoby zachowanie pliku. Licznik obejmuje wszystkie wygenerowane reguły, również automatycznie dodaną gwiazdkę.
Różnice względem .gitignore
Składnia jest podobna do .gitignore, ale nie identyczna. CODEOWNERS nie obsługuje negacji rozpoczynanej znakiem !, zakresów znaków w nawiasach kwadratowych ani uciekania początkowego # za pomocą ukośnika odwrotnego. Generator wykrywa te przypadki zamiast tworzyć pozornie poprawny plik. Jeżeli ścieżka ma spację, najbezpieczniej zastąpić ją wzorcem bez spacji lub zmienić nazwę katalogu; formularz rozdziela elementy reguły białymi znakami.
Uprawnienia i ochrona gałęzi
Poprawna linia nie gwarantuje przypisania recenzenta. Użytkownik lub zespół musi być widoczny w repozytorium i mieć wymagany dostęp, a zespół powinien należeć do tej samej organizacji. Sam plik sugeruje właścicieli. Aby ich akceptacja była obowiązkowa, skonfiguruj regułę ochrony gałęzi z opcją wymagania recenzji Code Owners. W projektach korzystających z GitLaba podobną politykę trzeba skonfigurować osobno; pomocny może być generator GitLab CI, ale jego plik nie zastępuje CODEOWNERS.
Lokalizacja pliku i utrzymanie reguł
GitHub szuka pliku w .github/, katalogu głównym repozytorium lub docs/, używając pierwszego znalezionego pliku. Nazwa musi brzmieć CODEOWNERS bez rozszerzenia. Reguły są odczytywane z gałęzi bazowej Pull Requesta, dlatego zmiana na gałęzi funkcji nie wpłynie na przypisanie recenzentów, dopóki nie trafi do gałęzi bazowej.
Najczęściej zadawane pytania
Czy CODEOWNERS automatycznie zatwierdza Pull Request?
Nie. Plik wskazuje osoby i może uruchomić prośbę o recenzję, ale nie udziela akceptacji. Wymóg zatwierdzenia przez właściciela trzeba włączyć w ochronie gałęzi lub rulesecie.
Czy można przypisać kilka zespołów do jednej ścieżki?
Tak. Wpisz kolejnych właścicieli po wzorcu, oddzielając ich spacjami. Prośba o recenzję może trafić do każdego wymienionego użytkownika lub zespołu, o ile ma on dostęp.
Dlaczego ostatnia reguła wygrywa?
Pozwala to zacząć od szerokiej odpowiedzialności, a potem nadpisać ją dla wrażliwego katalogu lub konkretnego typu plików. Z tego powodu generator zachowuje kolejność i duplikaty.
Jak sprawdzić działanie pliku?
Dodaj go do gałęzi bazowej, otwórz testowy Pull Request zmieniający wybraną ścieżkę i sprawdź listę żądanych recenzentów. Generator weryfikuje składnię lokalnie, ale nie może potwierdzić kont ani uprawnień.
Czy adres e-mail może być właścicielem?
GitHub dopuszcza adres powiązany z kontem, jednak nazwa użytkownika lub zespołu jest zwykle czytelniejsza i łatwiejsza w utrzymaniu. W publicznym repozytorium rozważ także ryzyko ujawnienia adresu.