Implementowanie niestandardowych zasad zaewidencjonowania analizy kodu dla kodu zarządzanego

Zasady ewidencjonowania analizy kodu określają zestaw reguł, które członkowie projektu usługi Azure DevOps muszą uruchamiać w kodzie źródłowym, zanim zostanie zaewidencjonowany w celu kontroli wersji. Firma Microsoft udostępnia zestaw standardowych zestawów reguł grupujących reguły analizy kodu w obszary funkcjonalne. Niestandardowe zestawy reguł ewidencjonowania zasad określają zestaw reguł analizy kodu specyficznych dla projektu. Zestaw reguł jest przechowywany w pliku .ruleset.

Zasady ewidencjonowania są ustawiane na poziomie projektu usługi Azure DevOps i określane przez lokalizację pliku ruleset w drzewie kontroli wersji. Nie ma żadnych ograniczeń dotyczących lokalizacji kontroli wersji zestawu reguł niestandardowych zasad zespołu.

Analiza kodu jest konfigurowana dla poszczególnych projektów kodu w oknie właściwości dla każdego projektu. Niestandardowy zestaw reguł dla projektu kodu jest określany przez fizyczną lokalizację pliku .ruleset na komputerze lokalnym. Po określeniu pliku zestawu reguł znajdujących się na tym samym dysku co projekt kodu program Visual Studio używa ścieżki względnej do pliku w konfiguracji projektu.

Sugerowaną praktyką tworzenia niestandardowego zestawu reguł projektu Usługi Azure DevOps jest przechowywanie pliku .ruleset zasad ewidencjonowania w folderze specjalnym, który nie jest częścią żadnego projektu kodu. Jeśli plik jest przechowywany w dedykowanym folderze, możesz zastosować uprawnienia ograniczające, kto może edytować plik reguły, i można łatwo przenieść strukturę katalogów zawierającą projekt do innego katalogu lub komputera.

Tworzenie niestandardowego zestawu reguł ewidencjonowania projektu

Aby utworzyć niestandardowy zestaw reguł dla projektu usługi Azure DevOps, należy najpierw utworzyć specjalny folder dla zestawu reguł ewidencjonowania zasad w Eksploratorze kontroli źródła. Następnie utworzysz plik zestawu reguł i dodasz plik do kontroli wersji. Na koniec należy określić zestaw reguł jako zasady ewidencjonowania analizy kodu dla projektu.

Uwaga

Aby utworzyć folder w projekcie usługi Azure DevOps, należy najpierw zamapować katalog główny projektu na lokalizację na komputerze lokalnym.

Aby utworzyć folder kontroli wersji dla zestawu reguł ewidencjonowania zasad

1. W programie Team Explorer rozwiń węzeł projektu, a następnie kliknij pozycję Kontrola źródła.

2. W okienku Foldery kliknij prawym przyciskiem myszy projekt, a następnie kliknij polecenie Nowy folder.

3. W głównym okienku Kontrola źródła kliknij prawym przyciskiem myszy pozycję Nowy folder, kliknij polecenie Zmień nazwę i wpisz nazwę folderu zestawu reguł.

Aby utworzyć zestaw reguł ewidencjonowania zasad

1. W menu Plik wskaż polecenie Nowy, a następnie kliknij pozycję Plik.

2. Na liście Kategorie kliknij pozycję Ogólne.

3. Na liście Szablony kliknij dwukrotnie pozycję Zestaw reguł analizy kodu.

4. Określ reguły do uwzględnienia w zestawie reguł, a następnie zapisz plik zestawu reguł w utworzonym folderze zestawu reguł.

Aby dodać plik zestawu reguł do kontroli wersji

1. W Eksploratorze kontroli źródła kliknij prawym przyciskiem myszy nowy folder, a następnie kliknij polecenie Dodaj elementy do folderu.

   Aby uzyskać więcej informacji, zobacz Git i Azure Repos.

2. Kliknij utworzony plik zestawu reguł, a następnie kliknij przycisk Zakończ.

   Plik jest dodawany do kontroli źródła i wyewidencjonowany.

3. W oknie Szczegóły Eksploratora kontroli źródła kliknij prawym przyciskiem myszy nazwę pliku, a następnie kliknij polecenie Zaewidencjonuj oczekujące zmiany.

4. W oknie dialogowym Zaewidencjonuj możesz dodać komentarz, a następnie kliknąć przycisk Synchronizacja.

   Uwaga

   Jeśli skonfigurowano już zasady ewidencjonowania analizy kodu dla projektu usługi Azure DevOps i wybrano opcję Wymuszaj zaewidencjonowanie, aby zawierać tylko pliki, które są częścią bieżącego rozwiązania, zostanie wyzwolone ostrzeżenie o niepowodzeniu zasad. W oknie dialogowym Niepowodzenie zasad wybierz pozycję Przesłoń niepowodzenie zasad i kontynuuj sprawdzanie. Dodaj wymagany komentarz, a następnie kliknij przycisk OK.

Aby określić plik zestawu reguł jako zasady ewidencjonowania

1. W menu Zespół wskaż pozycję Project Ustawienia, a następnie kliknij pozycję Kontrola źródła.

2. Kliknij pozycję Zasady zaewidencjonowania, a następnie kliknij przycisk Dodaj.

3. Na liście Zasady ewidencjonowania kliknij dwukrotnie pozycję Analiza kodu i upewnij się, że pole wyboru Wymuszaj analizę kodu dla kodu zarządzanego jest zaznaczone.

4. Na liście Uruchom ten zestaw reguł kliknij pozycję <Wybierz zestaw reguł z kontroli> źródła.

5. Wpisz ścieżkę pliku zestawu reguł ewidencjonowania w kontroli wersji.

   Ścieżka musi być zgodna z następującą składnią:

   $/ TeamProjectName / VersionControlPath

   Uwaga

   Ścieżkę można skopiować przy użyciu jednej z następujących procedur w Eksploratorze kontroli źródła:

   • W okienku Foldery kliknij folder zawierający plik zestawu reguł. Skopiuj ścieżkę kontroli wersji folderu wyświetlanego w polu Źródło i wpisz nazwę pliku zestawu reguł ręcznie.

   • W oknie szczegółów kliknij prawym przyciskiem myszy plik zestawu reguł, a następnie kliknij polecenie Właściwości. Na karcie Ogólne skopiuj wartość w polu Nazwa serwera.

Synchronizowanie projektów kodu z zestawem reguł ewidencjonowania

Należy określić zestaw reguł zasad ewidencjonowania projektu jako zestaw reguł analizy kodu konfiguracji projektu kodu w oknie dialogowym właściwości projektu kodu. Jeśli zestaw reguł znajduje się na tym samym dysku co projekt kodu, ścieżka względna służy do określania zestawu reguł po wybraniu ścieżki z okna dialogowego pliku. Ścieżka względna umożliwia przenoszenie ustawień właściwości projektu na inne komputery korzystające z podobnych lokalnych struktur kontroli wersji.

Aby określić zestaw reguł projektu jako zestaw reguł projektu kodu

1. W razie potrzeby pobierz folder zestawu reguł ewidencjonowania i plik z kontroli wersji.

   Ten krok można wykonać w Eksploratorze kontroli źródła, klikając prawym przyciskiem myszy folder zestawu reguł, a następnie klikając polecenie Pobierz najnowszą wersję.

2. W Eksplorator rozwiązań kliknij prawym przyciskiem myszy projekt kodu, a następnie kliknij polecenie Właściwości.

3. Kliknij pozycję Analiza kodu.

4. W razie potrzeby kliknij odpowiednie opcje na liście Konfiguracja i platforma .

5. Aby uruchomić analizę kodu za każdym razem, gdy projekt kodu jest kompilowany przy użyciu określonej konfiguracji, wybierz pozycję Uruchom w kompilacji w sekcji Analizatory binarne.

6. Na liście Uruchom ten zestaw reguł kliknij przycisk <Przeglądaj>.

7. Wybierz lokalną wersję pliku zestawu reguł ewidencjonowania.