Mit Issues und Pull-Requests arbeiten

Auf dieser Seite wird beschrieben, wie Sie im Secure Source Manager-Webinterface mit Problemen und Pull-Anfragen arbeiten.

Wenn Sie über die Weboberfläche auf die Secure Source Manager-Instanz zugreifen möchten, kopieren Sie die folgende URL in die Adressleiste Ihres Browsers.

INSTANCE_ID-PROJECT_NUMBER.LOCATION.sourcemanager.dev

Ersetzen Sie Folgendes:

  • INSTANCE_ID durch den Namen der Instanz.
  • PROJECT_NUMBER durch die Projektnummer der Instanz. Google CloudInformationen zum Identifizieren von Projekten finden Sie unter Projekte identifizieren.
  • LOCATION durch die Region der Instanz.

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen zuzuweisen, um die Berechtigungen zu erhalten, die Sie für die Arbeit mit Problemen und Pull-Anfragen benötigen:

Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

Informationen zum Zuweisen von Secure Source Manager-Rollen finden Sie unter Zugriffssteuerung mit IAM und Nutzern Instanzzugriff gewähren.

Pull-Anfragen ansehen

Sie können alle Pull-Anfragen aufrufen, auf die Sie Zugriff haben, oder Pull-Anfragen für ein bestimmtes Repository.

Leere Repositories haben keinen Tab Pull requests (Pull-Anfragen). Nachdem Sie Änderungen in ein Repository übertragen haben, können Sie den Tab „Pull-Anfrage“ aufrufen.

Wenn Sie die Ihnen zugewiesenen Pull-Anfragen oder Probleme aufrufen möchten, rufen Sie in Secure Source Manager den Tab Issues (Probleme) oder Pull requests (Pull-Anfragen) auf und klicken Sie auf Assigned to me (Mir zugewiesen).

So rufen Sie Pull-Anfragen für ein Repository auf:

  1. Wählen Sie in der Secure Source Manager-Weboberfläche Ihr Repository aus.
  2. Klicken Sie auf der Seite Ihres Repositorys auf den Tab Pull requests (Pull-Anfragen).
  3. Sie können die Pull-Requests über die Drop-down-Menüs für Assignee (Zuständige Person), Type (Typ) oder Sort (Sortieren) filtern oder sortieren.

So rufen Sie alle Pull-Anfragen auf:

  1. Klicken Sie in der Secure Source Manager-Weboberfläche auf den Tab Pull-Anfragen.

  2. Sie können die Pull-Requests über die Drop-down-Menüs für Assignee (Zugewiesener), Type (Typ) oder Sort (Sortieren) filtern oder sortieren.

Pull-Anfrage erstellen

  1. Wählen Sie in der Secure Source Manager-Weboberfläche das Repository aus, für das Sie eine Pull-Anfrage erstellen möchten.
  2. Klicken Sie auf der Repository-Seite auf den Tab Pull requests (Pull-Anfragen).
  3. Klicken Sie auf New pull request (Neue Pull-Anfrage).
  4. Wählen Sie im Menü Zusammenführen in den Branch aus, in den Sie den Pull-Request zusammenführen möchten.
  5. Wählen Sie im Menü pull from (ziehen von) den Branch aus, aus dem gezogen werden soll.
  6. Klicken Sie auf New pull request (Neue Pull-Anfrage).
  7. Geben Sie der Pull-Anfrage einen Titel und eine Beschreibung und hängen Sie alle relevanten Dateien an.

  8. Klicken Sie auf Pull-Anfrage erstellen.

    Sie werden zur Pull-Anfrage-Seite weitergeleitet, auf der Sie Reviewer, Labels, Meilensteine und zuständige Personen hinzufügen können.

Details der Pull-Anfrage bearbeiten

Sie können einer Pull-Anfrage Reviewer, Labels, Milestones, Assignees und ein Fälligkeitsdatum hinzufügen.

So fügen Sie Reviewer, Labels, Milestones und Assignees hinzu:

Klicken Sie auf der Seite der Pull-Anfrage neben den Details, die Sie bearbeiten möchten, auf das Zahnradsymbol Zahnradsymbol.

Änderungen werden automatisch gespeichert.

So aktualisieren Sie das Fälligkeitsdatum:

  1. Klicken Sie im Abschnitt Abgabetermin auf das Kalendersymbol und wählen Sie ein Datum aus.
  2. Klicken Sie auf das Pluszeichen Plussymbol, um das Fälligkeitsdatum zu speichern.

Pull-Anfrage prüfen

Prüfer können Kommentare hinzufügen, Änderungen anfordern und eine Pull-Anfrage genehmigen.

So prüfen Sie eine Ihnen zugewiesene Pull-Anfrage:

  1. Klicken Sie in der Secure Source Manager-Weboberfläche auf den Tab Pull-Anfragen.
  2. Klicken Sie auf Ihnen zugewiesen.

  3. Klicken Sie auf die Pull-Anfrage, die Sie überprüfen möchten.

    Die Seite Konversation wird geöffnet. Sie können alle Kommentare des Autors der Pull-Anfrage oder anderer Prüfer ansehen.

  4. Wenn Sie die geänderten Dateien ansehen und kommentieren möchten, klicken Sie auf den Tab Files changed (Geänderte Dateien). Sie können das Verhalten der Leerzeichen-Sichtbarkeit sowie die Ansichts- und Diff-Optionen ändern, indem Sie auf die Drop-down-Menüs Leerzeichen, Geteilte Ansicht/Einheitliche Ansicht und Diff-Optionen klicken.

  5. Wenn Sie einen Kommentar hinterlassen möchten, klicken Sie neben der Zeile, die Sie kommentieren möchten, auf das Pluszeichen.

  6. Klicke auf Überprüfung starten.

  7. Klicken Sie auf das Pluszeichen in der Zeile, die Sie kommentieren möchten, und dann auf Kommentar hinzufügen, um zusätzliche Kommentare zu hinterlassen.

    Kommentare unterstützen die Formatierung mit Markdown.

  8. Wenn Sie Kommentare senden, die Pull-Anfrage genehmigen oder Änderungen anfordern möchten, klicken Sie auf Prüfen.

  9. Geben Sie einen Kommentar ein, um Ihre Änderungen zusammenzufassen, oder lassen Sie das Kommentarfeld leer und wählen Sie eine der folgenden Optionen aus:

    • Genehmigen: Genehmigen Sie die Änderungen.
    • Kommentieren: Sie können Kommentare senden, ohne die Pull-Anfrage zu genehmigen.

    • Änderungen anfordern: Sie können Änderungen an der Pull-Anfrage anfordern.

Pull-Anfragen zusammenführen

  1. Klicken Sie auf der Repository-Seite auf den Tab Pull requests (Pull-Anfragen).
  2. Wählen Sie die Pull-Anfrage aus, die Sie zusammenführen möchten.
  3. Wenn keine Konflikte vorliegen, klicken Sie auf Pull-Anfrage zusammenführen.

Probleme ansehen

  1. Wählen Sie in der Secure Source Manager-Weboberfläche Ihr Repository aus.
  2. Klicken Sie auf der Repository-Seite auf den Tab Probleme.
  3. Sie können die Probleme über die Menüs Zuständiger, Typ oder Sortieren filtern oder sortieren.

Problem erstellen

  1. Wählen Sie in der Secure Source Manager-Weboberfläche Ihr Repository aus.
  2. Klicken Sie auf der Repository-Seite auf den Tab Issues.
  3. Klicken Sie auf Neues Problem.
  4. Geben Sie den Titel und die Beschreibung des Problems ein und klicken Sie dann auf Create Issue (Problem erstellen).

  5. Auf der Seite „Problemdetails“ können Sie Labels, Meilensteine, Zuständige und eine Verzweigung oder ein Tag zuweisen.

Diagramme mit Mermaid hinzufügen

Secure Source Manager unterstützt das Rendern von Mermaid-Diagrammen in Markdown-Dateien (z. B. README.md), Pull-Anfrage-Beschreibungen, Issues und Kommentaren.

Verwenden Sie einen mermaid-Codeblock mit Begrenzung, um ein Diagramm hinzuzufügen:

```mermaid
graph TD
    A[Write Markdown] --> B(Click Preview Tab)
    B --> C{Does it render?}
    C -- Yes --> D[Success]
    C -- No --> E[Check Syntax]
```

Klicken Sie im Markdown-Editor auf den Tab Vorschau, um zu prüfen, ob Ihr Diagramm gerendert wird, bevor Sie es speichern.

Unterstützte Diagrammtypen

Secure Source Manager unterstützt die folgenden Mermaid-Diagrammtypen:

  • Flussdiagramme: graph oder flowchart (unterstützt TD, TB, LR, BT, RL)
  • Sequenzdiagramme: sequenceDiagram
  • Klassendiagramme: classDiagram
  • ER-Diagramme: erDiagram
  • Zustandsdiagramme: stateDiagram oder stateDiagram-v2
  • XY-Diagramme: xychart-beta oder xychart

Rendering-Verhalten und Einschränkungen

  • Statische Darstellung: Diagramme werden als statische Bilder gerendert. Interaktive Funktionen (z. B. click-Callbacks und Tooltips) und externe Scripts sind aus Sicherheitsgründen deaktiviert.
  • Designanpassung: Diagramme werden automatisch an helle und dunkle Designs angepasst.
  • Barrierefreiheit: Gerenderte Diagramme enthalten Alternativtext, der mit dem Quellcode des Diagramms für Screenreader gefüllt wird.
  • Nicht unterstützte Diagrammtypen: Bei nicht unterstützten Diagrammtypen wird eine Fehlermeldung angezeigt und sie werden nicht gerendert. Dazu gehören Gantt-, Mindmap-, Kreis-, Gitgraph-, User Journey-, Requirement-, C4-, Zeitachsen-, Sankey- und Blockdiagramme. Bei nicht unterstützten Diagrammtypen rendern Sie das Diagramm lokal als Bild (PNG oder SVG) und betten es mit der standardmäßigen Markdown-Bildsyntax ein.

Nächste Schritte