Freigeben über


Exemplarische Vorgehensweise: Anpassen von Eincheckrichtlinien und Hinweisen

Visual Studio Team Foundation Server ermöglicht das Erstellen von benutzerdefinierten Eincheckrichtlinien wie den folgenden:

  • Erstellen von Vorlagen und Anforderungen für Eincheckhinweise

    Sie können eigene Felder zum Erfassen von Eincheckinformationen erstellen, die die Angabe bestimmter Informationen durch den Benutzer beim Eincheckvorgang erfordern. Diese Informationen werden ähnlich wie Eincheckkommentare zusammen mit anderen Details von Differenzmengen beibehalten und der E-Mail-Nachricht an die anderen Teammitglieder beigefügt.

  • Definieren von Eincheckrichtlinien

    Sie können Eincheckrichtlinien definieren, um Einschränkungen für die Änderungen zu erzwingen, für die ein Commit an den Quellcodeverwaltungs-Server ausgeführt wird. Beispielsweise kann ein Projektadministrator Regeln für die Validierung von Quellcodeänderungen vor dem Durchführen eines Commits an den Server definieren. Team Foundation enthält Eincheckrichtlinien, mit denen überprüft werden kann, ob Arbeitsaufgaben Änderungen zugeordnet sind, Komponententests erfolgreich durchgeführt und statische Analysen des Quellcodes fehlerfrei ausgeführt werden. Diese Richtlinien können durch ein Plug-In-Modell erweitert werden, sodass Sie zusätzliche Anforderungen einfach durch Erstellen eines neuen Richtlinien-Plug-Ins erzwingen können. Die auf das Teamprojekt angewendeten Eincheckrichtlinien hängen vom durch das Teamprojekt verwendeten MSF-Prozess ab. Weitere Informationen finden Sie unter Suchen und Verwenden von Prozessleitfäden.

In dieser exemplarischen Vorgehensweise wird beschrieben, wie Sie Eincheckhinweise hinzufügen und wie Sie eine Eincheckrichtlinie definieren, die eine Zuordnung von Arbeitsaufgaben bei jedem Einchecken erfordert.

Erstellen von Eincheckhinweisen

In Visual Studio Team Foundation Server können Sie eigene Felder für Eincheckhinweise des Teams definieren, und Sie können Benutzeranforderungen für das Einchecken auf Stammordnerebene für den Server definieren (z. B. $/folder1). Diese Ordner entsprechen den Teamprojekten. Die Einstellungen gelten dann für den gesamten Quellcode in diesen Ordnern. Wenn ein Benutzer Überarbeitungen in einen Ordner auf dem Server einchecken möchten, für den benutzerdefinierte Eincheckhinweise oder -anforderungen gelten, wird der Benutzer aufgefordert, die Angaben im Dialogfeld Einchecken oder im Fenster Einchecken zu vervollständigen. Eincheckhinweise sind entweder optional oder obligatorisch. Die einzige Validierung für obligatorische Hinweise besteht jedoch darin, dass der angegebene Text größer als 0 (null) sein muss.

So fügen Sie Eincheckhinweise hinzu und konfigurieren diese

  1. Klicken Sie in Team Explorer mit der rechten Maustaste auf das Teamprojekt, klicken Sie auf Teamprojekteinstellungen und dann auf Quellcodeverwaltung.

    Das Dialogfeld Einstellungen für Quellcodeverwaltung wird angezeigt.

  2. Klicken Sie auf die Registerkarte Eincheckhinweise und dann auf Hinzufügen.

    Das Dialogfeld Eincheckhinweis hinzufügen wird angezeigt.

  3. Geben Sie im Dropdown-Listenfeld Name den Namen für den neuen Eincheckhinweis ein, z. B. "Doc Impact" für das Dokumentationsteam.

  4. Wählen Sie optional Bei Eincheckvorgängen erforderlich aus, und klicken Sie auf Hinzufügen.

    Hierdurch wird beim Eincheckvorgang das Hinzufügen von Text für diesen Eincheckhinweis erforderlich.

  5. Darüber hinaus können Sie die Reihenfolge der Eincheckhinweise verändern, indem Sie einen Eincheckhinweis auswählen und mithilfe der Pfeiltasten verschieben.

  6. Wenn Sie mit den Einstellungen für die Eincheckhinweise zufrieden sind, klicken Sie auf OK.

    Die neuen Eincheckhinweise werden ab sofort bei Eincheckvorgängen angezeigt.

Wenn Sie die neuen Eincheckhinweise anzeigen möchten, checken Sie eine Datei aus einem ordnungsgemäß konfigurierten Ordner auf Stammebene aus, bearbeiten Sie diese, und checken Sie die Überarbeitungen an der Eingabeaufforderung ein. Wählen Sie im Dialogfeld Einchecken den Channel "Eincheckhinweise" aus, um die benutzerdefinierten Felder anzuzeigen.

Definieren von Eincheckrichtlinien

Wenn Sie weitere Anpassungen für die Eincheckvorgänge vornehmen möchten, können Sie Eincheckrichtlinien definieren, mit denen die Übereinstimmung von Änderungen mit Organisationsstandards überprüft wird.

So definieren Sie eine neue Eincheckrichtlinie

  1. Klicken Sie in Team Explorer mit der rechten Maustaste auf das Teamprojekt, klicken Sie auf Teamprojekteinstellungen und dann auf Quellcodeverwaltung.

    Das Dialogfeld Einstellungen für Quellcodeverwaltung wird angezeigt.

  2. Klicken Sie auf die Registerkarte Eincheckrichtlinien und dann auf Hinzufügen.

    Das Dialogfeld Eincheckrichtlinie hinzufügen wird angezeigt.

  3. Wählen Sie im Listenfeld unter Eincheckrichtlinie den gewünschten Richtlinientyp aus, und klicken Sie auf OK. Die verfügbaren Richtlinientypen sind Codeanalyse, Testrichtlinie sowie Arbeitsaufgaben.

    Wenn Sie Codeanalyse auswählen, wird der Codeanalyserichtlinien-Editor.

  4. Klicken Sie auf alle festzulegenden Regeln und dann auf OK.

    Wenn Sie Testrichtlinie ausgewählt haben, wird das Dialogfeld Testrichtlinie angezeigt.

  5. Klicken Sie auf Durchsuchen, um eine Metadatendatei anzugeben, wählen Sie den gewünschten Test aus, und klicken Sie dann auf OK.

    Wenn Sie Arbeitsaufgaben auswählen, wird der Arbeitsaufgaben-Richtlinientyp im Dialogfeld Einstellungen für die Quellcodeverwaltung hinzugefügt.

  6. Wenn Sie mit den Einstellungen für die Eincheckrichtlinien zufrieden sind, klicken Sie auf OK.

    Die neuen Eincheckrichtlinien werden ab sofort bei Eincheckvorgängen angezeigt.

Wenn Sie die Eincheckrichtlinie anzeigen möchten, checken Sie eine Datei aus dem Ordner aus, für den Sie gerade eine Eincheckrichtlinie definiert haben, und bearbeiten Sie diese. Checken Sie anschließend die überarbeitete Datei mithilfe des Dialogfelds Einchecken oder mithilfe des Fensters Ausstehende Änderungen in Visual Studio ein. Sie können auch tf checkin an der Eingabeaufforderung eingeben.

Wählen Sie den Channel Richtlinienwarnungen im Dialogfeld oder Toolfenster aus, um eine Nachricht anzuzeigen, die angibt, ob die Änderungen mit den definierten Eincheckrichtlinien kompatibel sind. Wenn Sie keine Arbeitsaufgabe im Channel Arbeitsaufgaben ausgewählt haben, wird eine Meldung angezeigt, die angibt, dass keine Richtlinienkompatibilität besteht. Wählen Sie im Channel Arbeitsaufgabe eine Arbeitsaufgabe aus, und ordnen Sie diese der Änderung zu, um Richtlinienkompatibilität herzustellen. Sie können den Eincheckvorgang jedoch auch ohne Richtlinienkompatibilität fortsetzen. Wenn Sie diese Vorgehensweise wählen, werden Sie aufgefordert, einen Grund für das Überschreiben der Eincheckrichtlinie anzugeben.

Erstellen von Richtlinien-Plug-Ins

Sie können mithilfe der Erweiterungen vom Visual Studio Team Foundation Server SDK benutzerdefinierte Richtlinien-Plug-Ins erstellen, die im Dialogfeld Eincheckrichtlinie hinzufügen angezeigt werden. Das Visual Studio Team Foundation Server SDK kann unter https://go.microsoft.com/fwlink/?linkid=68586 als Komponente von Visual Studio SDK gedownloadet werden. Weitere Informationen zu Richtlinien-Plug-Ins finden Sie nach der Installation des SDKs in der Visual Studio SDK-Hilfe.

Sicherheit

Um diese exemplarische Vorgehensweise abzuschließen, müssen Sie über die Berechtigung Einchecken und die Berechtigung Serverebeneninformationen bearbeiten verfügen. Weitere Informationen finden Sie unter Team Foundation Server-Berechtigungen.

Siehe auch

Aufgaben

Exemplarische Vorgehensweise: Navigieren in der Team Foundation-Quellcodeverwaltung

Referenz

Befehl Add

Weitere Ressourcen

Exemplarische Vorgehensweisen für die Team Foundation-Quellcodeverwaltung