Wie Sie IronPDF mit GitHub Copilot verwenden
Die meisten Anleitungen zum KI-unterstützten Programmieren setzen voraus, dass Sie bereit sind, den Editor zu wechseln. Für .NET-Arbeiten ist diese Annahme oft falsch. IronPDF-Projekte, die in Visual Studio leben, befinden sich in Lösungen mit Projektverweisen, NuGet-Konfiguration und einer Build-Pipeline, die niemand verlagern möchte, nur um einen Assistenten auszuprobieren.
GitHub Copilot läuft dort, wo diese Projekte bereits sind, in Visual Studio, VS Code und JetBrains IDEs, daher erfordert dieser Workflow keine Migration. Es tut auch etwas, was kein reiner Editor-Assistent kann: Es läuft innerhalb von GitHub selbst. Sie können ein PDF-Problem in einem Ticket beschreiben, es dem Cloud-Agenten von Copilot zuweisen und eine Pull-Anfrage zurückerhalten. IronPDF rendert HTML, CSS und JavaScript zu PDF über eine integrierte Chromium-Engine, und es gibt keine Integration zwischen den beiden Produkten. Was sie verbindet, ist das Repository und die Konventionen, die Sie darin festlegen.
Zuerst eine Unterscheidung, weil zwei ähnliche Themen konkurrieren. Diese Anleitung handelt davon, einen KI-Programmierassistenten zu benutzen, um Software zu erstellen mit IronPDF. Es geht nicht darum, KI-Modelle zu nutzen, um PDF-Inhalte zu lesen oder zu analysieren, was das KI-gestützte PDF-Verarbeitungs-Tutorial separat behandelt.
SchnellstartÖffnen Sie die Lösung in der IDE, in der sie sich bereits befindet, und fragen Sie nach dem Dokument:
In this C# console project, create Program.cs that uses IronPDF to render
"<h1>Hello from IronPDF</h1>" to hello.pdf. Read the license key from the
IRONPDF_LICENSE_KEY environment variable, never inline. Then build and fix
any errors.
Copilot schreibt die wenigen Zeilen, die wichtig sind, erstellt einen ChromePdfRenderer, ruft RenderHtmlAsPdf auf und speichert das Ergebnis mit SaveAs. Dieser Teil ist unauffällig, und es ist nicht der Grund, warum diese Anleitung existiert. Was folgt, ist: Der gleiche Assistent wird diese Arbeit ohne Aufsicht auf einem Branch als Pull-Request erledigen, und das ändert, was Sie einrichten müssen.
Zwei Sicherheitshinweise, beide kurz. Ein Lizenzschlüssel gehört nie direkt in einen Prompt oder in einen Commit; es befindet sich in der Konfiguration, wie der Lizenzschlüssel-Leitfaden beschreibt, oder in einer Umgebungsvariable oder einem Repository-Geheimnis. Und ein Agent mit Schreibzugriff auf das Repository öffnet echte Pull-Requests, sodass Branch-Schutz und menschliche Überprüfung die entscheidende Kontrolle bleibt.
Minimaler Arbeitsablauf (5 Schritte)
- Laden Sie die C# PDF-Bibliothek von NuGet herunter
- Commit
.github/copilot-instructions.mdmit den IronPDF-Konventionen des Projekts - Verwenden Sie Inline-Chat für kleine Änderungen und den Agentenmodus für Arbeiten mit mehreren Dateien
- Für unbeaufsichtigte Arbeit erstellen Sie ein detailliertes Ticket und weisen es dem Cloud-Agenten zu.
- Überprüfen Sie den Pull-Request, indem Sie jeden API-Namen mit der API-Referenz vergleichen.
Wo passt Copilot in ein bereits in Visual Studio bestehendes Projekt?
Copilot arbeitet in drei Bereichen, und die Wahl des richtigen spart mehr Zeit als jede Prompt-Technik.
Inline-Vervollständigungen und Chat behandeln alles, was Sie in einem Satz beschreiben können und das sich in einer einzigen Datei befindet: ein Seitenrand anpassen, einen Footer zu einem bestehenden Renderer-Aufruf hinzufügen, einen Helfer umbenennen. Sie beschreiben die Änderung, Sie erhalten ein diff vor Ort, Sie nehmen an oder nicht.
Agentenmodus behandelt Arbeiten, die mehrere Dateien umfassen, wobei Copilot entscheidet, welche Dateien zu bearbeiten sind, Terminalbefehle ausführt, die Ausgabe liest und bei Fehlern iteriert. Dies ist der richtige Bereich für eine Migration oder eine Umgestaltung.
Der Cloud-Agent auf GitHub bearbeitet Arbeit, die überhaupt keiner Beaufsichtigung bedarf. Sie ordnen ein Issue zu, es plant, drückt einen Branch und öffnet einen Pull-Request. Dies ist, was Copilot von einem editorgebundenen Assistenten unterscheidet, und hier liegt die Aufmerksamkeit des Rests dieser Anleitung.
Copilot ist auch ein vernünftiger Leser. Es zu bitten, den Rendering-Options-Typ zu erklären und aufzulisten, welche das Projekt derzeit festlegt, verwandelt die API-Referenz in etwas, das Sie abfragen können, anstatt zu scrollen.
Wie übernimmt man Konventionen, denen jede Fläche folgt?
Repository-spezifische Anweisungen werden dem Repository hinzugefügt, was bedeutet, dass sie die IDE-Unterhaltung und den autonomen Agenten gleichermaßen regeln, auch wenn der Agent ohne Aufsicht arbeitet. Schreiben Sie sie einmal, dann hören Sie auf, sich in Prompts zu wiederholen.
Die Datei ist .github/copilot-instructions.md. Für ein .NET-Team ist dies das Format, auf das es sich zu standardisieren lohnt, da es das ist, das Visual Studio für das Laden von Dokumenten beschreibt, neben VS Code, JetBrains, dem Cloud-Agenten und der Copilot-Codeüberprüfung. Copilot liest auch andere Anweisungsdateien, darunter AGENTS.md, aber die Unterstützung variiert je nach Oberfläche, sodass der sicherste Standard für einen Visual Studio-Shop die nach dem Produkt benannte Datei ist.
# Copilot instructions
## PDF generation
- Use IronPDF for all PDF generation. Use ChromePdfRenderer for HTML conversion.
- Target the IronPDF version pinned in Directory.Packages.props. Do not upgrade
it as part of an unrelated change.
- Never inline a license key. Read it from configuration or the
IRONPDF_LICENSE_KEY environment variable.
- Prefer the shared PdfDocumentService helper over constructing a renderer per
call. A ChromePdfRenderer instance is reusable.
- Use the async rendering methods in web request paths.
- Do not invent IronPDF API names. If a method is uncertain, say so and cite the
documentation rather than guessing.
## Testing
- Assert on extracted text, page count and the %PDF- signature.
- Never use golden-file byte comparisons; rendering output is not byte-stable.
Die Zeile über das Eingestehen von Unsicherheit ist gerechtfertigt. Das Modell produziert standardmäßig etwas Plausibles, anstatt eine Lücke einzugestehen, und das Erfinden von renderer.ConvertHtmlToPdfDocument() liest sich bis zum Widerspruch des Compilers perfekt. Die Erlaubnis zu geben, aufzuhören, ist billig und funktioniert.
Pfadspezifische Anweisungen in .github/instructions/**/*.instructions.md beschränken Anleitungen auf passende Dateien, wodurch PDF-Konventionen aus Anfragen entfernt werden, die nichts mit PDFs zu tun haben.
Was macht ein Issue, auf das der Agent tatsächlich reagieren kann?
Hier ist die Fertigkeit, die zählt, nicht das Schreiben von Prompts. Es geht um das Schreiben von Tickets, denn, laut GitHub, arbeitet der Agent anhand des Titels, der Beschreibung und bestehender Kommentare eines Tickets und sieht keine nachträglich hinzugefügten Kommentare. Niemand ist anwesend, um es zu klären.
Ein schwaches Issue sieht so aus:
Title: PDF looks wrong
The invoice PDF doesn't look right. Can we fix the layout?
Der Agent hat keine Datei zu öffnen, keine Ahnung, welches der mehreren PDFs gemeint ist, keine Beschreibung des korrekten Outputs und keinen Fehler, von dem er ausgehen könnte. Er wird erkunden, raten und einen Pull-Request erstellen, der möglicherweise das völlig falsche adressiert.
Ein starkes Issue enthält alles, was ein Kollege benötigen würde:
Title: Invoice PDF splits table rows across pages and drops the logo
**Files:** Services/InvoiceRenderer.cs, Templates/invoice.html
**IronPDF version:** as pinned in Directory.Packages.props
**Framework:** .NET 8
**Expected:** A4 portrait, 20mm margins. Line-item table rows stay intact
across page breaks. Company logo renders in the header.
**Actual:** A table row splits between pages 1 and 2. The logo area is blank
in the PDF but renders correctly when Templates/invoice.html is opened in
Chrome. No exception is thrown.
**Constraints:** Fix page-break behavior in CSS, not in C#. Keep the public
signature of InvoiceRenderer.RenderAsync unchanged. No new packages.
**Acceptance:** Existing tests pass, plus a new test asserting page count for
the fixture in TestData/invoice-12-items.json.
Sechs Dinge unterscheiden das zweite vom ersten: benannte Dateien, die Framework- und Bibliotheksversion, die konkret erwartete Ausgabe, das tatsächliche Verhalten inklusive was nicht passiert, harte Einschränkungen und eine Definition von 'erledigt'.
Dieses Detail, dass keine Ausnahme ausgelöst wird, leistet echte Arbeit. Es sagt dem Agenten, dass es sich um ein Rendering-Problem handelt und nicht um einen Absturz, was eine ganze Kategorie von Untersuchungen ausschließt, bevor sie beginnt. Die Beobachtung, dass das Logo in Chrome gerendert wird, aber nicht im PDF, verengt es weiter: Ein roher HTML-String enthält keine Dokumentenposition, sodass relative Bildpfade sich relativ zum Arbeitsverzeichnis des Prozesses auflösen, anstatt zu dem der Vorlage, während ein Browser weiß, woher die Seite kam.
Sobald zugewiesen, plant der Agent, drückt einen Branch, öffnet einen Pull-Request und fordert eine Überprüfung an. Sie überprüfen das Diff, anstatt die Arbeit zu beobachten.
Warum schlagen die Tests des Agenten in einem IronPDF-Projekt fehl?
Dies ist der Abschnitt, den kein allgemeiner Copilot-Leitfaden schreiben wird, und er ist derjenige, der Ihnen wahrscheinlich einen Nachmittag spart.
Der Cloud-Agent baut und testet in seiner eigenen flüchtigen Umgebung. Für die meisten Projekte reicht Quelle plus ein Paket-Wiederherstellung aus. Ein IronPDF-Projekt benötigt mehr, weil Rendering von einer Chromium-Engine mit nativen Plattformabhängigkeiten abhängt. Wenn diese im Linux-Runner des Agenten nicht vorhanden sind, schlägt jeder Test, der ein PDF rendert, fehl, aus Gründen, die nichts mit dem Code zu tun haben, den der Agent gerade geschrieben hat.
Die Folge ist schlimmer als ein roter Build. Selbst fehlende Abhängigkeiten zu finden und zu installieren, arbeitet der Agent nach dem Prinzip von Versuch und Irrtum, was in der Dokumentation von GitHub als langsam und unzuverlässig bezeichnet wird.
Die Lösung besteht darin, die Umgebung vorab mit .github/workflows/copilot-setup-steps.yml zu konfigurieren. Es sieht aus wie ein gewöhnlicher GitHub Actions-Workflow mit zwei leicht zu übersehenden Regeln: Der Job muss copilot-setup-steps genannt werden und die Datei wird nicht ausgelöst, wenn sie nicht auf dem Standardbranch Ihres Repositories existiert.
name: "Copilot Setup Steps"
on:
workflow_dispatch:
push:
paths:
- .github/workflows/copilot-setup-steps.yml
pull_request:
paths:
- .github/workflows/copilot-setup-steps.yml
jobs:
# The job MUST be called `copilot-setup-steps` or Copilot will not pick it up.
copilot-setup-steps:
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@v4
- uses: actions/setup-dotnet@v4
with:
dotnet-version: '8.0.x'
# Install the native dependencies IronPDF's Chromium engine needs on
# Debian-based images. Take the current package list from the Docker
# and Linux deployment guide rather than copying one from anywhere else,
# because it changes between releases.
- name: Install IronPDF native dependencies
run: |
sudo apt-get update
sudo apt-get install -y <packages from the IronPDF Linux guide>
- run: dotnet restore
Zwei Details entscheiden, ob dies funktioniert.
Erstens ist ein Lizenzschlüssel dem Agenten nicht automatisch verfügbar. GitHub Actions, Codespaces und Dependabot-Geheimnisse stehen einer Agenten-Sitzung nicht zur Verfügung, daher muss der Schlüssel separat als Agents secret in den Einstellungen des Repositories oder der Organisation hinzugefügt werden.
Zweitens, und das ist der eine, der das verwirrende Symptom hervorruft: wenn ein Setup-Schritt fehlschlägt, hält Copilot nicht an. Es überspringt die verbleibenden Schritte und beginnt mit dem, in welchem Zustand sich die Umgebung befindet. Ein still gescheiterter Abhängigkeitsinstallation sieht daher genau wie ein Code-Problem aus. Führen Sie den Workflow manuell über den Action-Tab einmal aus, bevor Sie sich darauf verlassen.
Was sollten Sie prüfen, bevor Sie zusammenführen?
Der Pull-Request ist die Überprüfungsoberfläche, und dieselben Standards gelten wie bei jedem Zweig eines Kollegen. Copilots eigene Code-Überprüfung kann als zweite Überprüfung des Agentenausgangs laufen, die mechanische Probleme einfängt, bevor ein Mensch das Diff liest.
Drei Überprüfungen sind speziell für IronPDF-Änderungen von Bedeutung:
- Kommt jeder API-Name in der Dokumentation vor, oder ist etwas Plausibles durchgerutscht?
- Sieht das generierte PDF tatsächlich richtig aus? Ein sauberer Build sagt nichts über das Layout aus.
- Blieb die Änderung innerhalb der vom Ticket festgelegten Grenzen?
Tests im selben Pull-Request anzufordern, lohnt sich als Standard:
Add xUnit tests for this change: output is non-empty, begins with the %PDF-
signature, extracted text contains the bound company name, and page count
matches the fixture. No golden-file byte comparisons.
Der Ausschluss von Byte-Vergleichen verhindert eine Klasse von instabilen Tests, die andernfalls einen Nachmittag kosten würden, da zwei Renderings desselben HTMLs in separaten Prozessen sich in ihren Zeitstempeln und Dokumenten-IDs unterscheiden.
Wann ist es der Code und wann ist es der Container?
Drei dokumentierte Ursachen für Renderunterschiede zwischen Browser und PDF sind ein Stylesheet, das für Bildschirm- statt Druckmedien geschrieben wurde, eine Webschrift, die beim Berechnen des Layouts nicht geladen war, und von JavaScript erzeugter Inhalt, der zu früh erfasst wurde. Alle drei sind auf der Code-Seite, und alle drei lohnen sich, im Antrag genannt zu werden:
Templates/report.html renders correctly in Chrome but the PDF splits a table
row across pages and the totals block lands on the next page alone.
Explain the cause before changing anything, then fix it in the CSS using page
break properties. Do not modify ReportRenderer.cs.
Um eine Diagnose zu bitten, bevor eine Änderung vorgenommen wird, gibt Ihnen etwas zu bewerten, statt einer Lösung, die reverse-engineered werden muss. Das Verhalten bei Seitenumbrüchen gehört ins Stylesheet, und der Leitfaden zu Seitenumbrüchen behandelt die relevanten Eigenschaften. Die Änderung auf CSS zu beschränken, hält einen Agenten davon ab, ein Layoutproblem durch Umstrukturierung des C# zu lösen.
Die andere Hälfte der Frage ist die, die der vorherige Abschnitt beantwortet hat: Wenn derselbe Code lokal gerendert wird und in einem Container oder auf einem Runner fehlschlägt, ist es meist kein Code-Problem. Fügen Sie die vollständige Ausnahme ein, anstatt sie zu umschreiben, und richten Sie den Antrag an die Docker-Datei statt an die Anwendung. Eine fehlende gemeinsam genutzte Bibliothek ist kein C#-Problem.
Was haben die Aufforderungen in einem realen Lauf erzeugt?
Die drei Eingabeaufforderungen und die zwei Tickettexte auf dieser Seite wurden der Reihe nach und unbeaufsichtigt mit GitHub Copilot CLI 1.0.95 ausgeführt, welches jeden Schritt an GPT-6 Luna weiterleitete. Die Anweisungsdatei und der Workflow der Einrichtungsschritte wurden wie geschrieben committet. Die unten stehenden Zahlen stammen aus unabhängigen Überprüfungen der von der Ausführung hinterlassenen Dateien.
- Der Schnellstart-Eingabebefehl erzeugte ein 13-zeiliges Program.cs, das den Schlüssel aus IRONPDF_LICENSE_KEY las und fehlerfrei kompiliert wurde.
- Der Agent führte das Programm nicht aus.
- Mit dem Schlüssel ausgeführt, speicherte das Programm eine einseitige hello.pdf mit 17.385 Bytes.
- Bevor die Tickets ausgeführt wurden, teilte die Rechnung einen Posten zwischen den Seiten 1 und 2 auf und enthielt kein Bild.
- Das starke Ticket erzeugte eine zweiseitige Rechnung mit jedem Posten vollständig und dem Logo auf Seite 1.
- Der Agent bettete das Logo als Data-URI in C# ein und korrigierte die Seitenumbrüche im CSS.
- Die öffentliche Signatur von InvoiceRenderer.RenderAsync blieb unverändert und es wurde kein Paket hinzugefügt.
- Der neue Test forderte zwei Seiten für die 12-Posten-Vorrichtung an und alle 3 Tests bestanden.
- Der Agent fügte eine Regel hinzu, die Tabellenüberschrift zu wiederholen und berichtete, dass sie wiederholt wurde. Seite 2 der gerenderten Rechnung enthielt keine Überschriftenzeile.
- Das schwache Ticket behob ebenfalls beide Mängel, obwohl weder eine Datei noch ein spezifisches Symptom genannt wurde.
- Die gleiche Änderung schrieb das gesamte Stylesheet um und reduzierte die Schriftgröße des Textkörpers von 13 auf 11 Pixel.
- Das Test-Kommand fügte den bestehenden Tests eine Nicht-Leer-Prüfung und eine Firmenname-Prüfung hinzu, sodass die Anzahl bei 3 blieb und keine Bytes verglichen wurden.
- Das Bericht-Kommand benannte den erzwungenen Seitenumbruch vor den Gesamtsummen und die fehlende Zeilenregel als Ursachen, bevor es das CSS bearbeitete.
- Der behobene Bericht passte auf 2 statt 3 Seiten, ohne geteilte Zeilen und mit den Gesamtsummen unter den letzten vier Punkten. ReportRenderer.cs blieb unverändert.
- Der Agent listete keine Umgebungsvariablen auf und der Schlüssel tauchte in keinem Transkript, Commit oder Copilot-Sitzungsdatei auf.
- Einige Schritte liefen anders als die Seite. Das Repository hatte kein GitHub-Remote, also stand das CLI für den Cloud-Agenten ein und jedes Ticket startete eine neue Sitzung. Die Tests-Anfrage ging in die Sitzung des starken Tickets und nicht in einen Pull-Anfrage-Kommentar. Die Workflow-Schritte zur Einrichtung wurden nicht ausgeführt, da diese Maschine keinen GitHub Actions-Runner und keine Linux-Umgebung hat.
Die Rechnung nach dem starken Ticket, gerendert vom InvoiceRenderer des Laufs aus der 12-Posten-Vorrichtung.
Der Bericht nach der CSS-Reparatur aus der Bericht-Aufforderung, gerendert vom ReportRenderer des Laufs.
Die Copilot CLI-Version, das Modell und das Timing für diesen Lauf sind im Laufprotokoll aufgeführt.
Was funktioniert weiter, wenn niemand zusieht?
Zwei Dinge, und sie sind die beiden, die es als Erstes einzurichten gilt. Committete Anweisungen in .github/copilot-instructions.md regeln den Agenten auf einem Branch um Mitternacht genauso, wie sie Ihre IDE am Mittag regeln. Ein copilot-setup-steps.yml, das die nativen Abhängigkeiten von IronPDF installiert, ist das, was dem gleichen Agenten erspart, sie durch Ausprobieren zu finden und zu installieren. Alles andere ist gewöhnliche Assistentennutzung, die zufällig besser funktioniert, wenn diese beiden vorhanden sind.
Die Verifizierungsgewohnheit ändert sich nicht mit dem Bereich: frühzeitig bauen, das PDF öffnen und die API-Namen mit der Dokumentation abgleichen, bevor irgendetwas ausgeliefert wird. Die reproduzierbare Version dieser Überprüfung, die von Anfang bis Ende mit einem veröffentlichten Ergebnis durchgeführt wird, finden Sie im Leitfaden zu AI-Programmierassistenten, sowie die Leitfäden für Claude Code, ChatGPT Codex und Cursor.
Fehlerbehebung
- Einen Lizenzschlüssel in IronPDF anwenden: wenn das Speichern des PDFs eine Lizenz-Exception wirft
- RenderingOptions korrekt initialisieren: wenn ein vorgeschlagener Optionsname nicht aufgelöst wird
- Welche Version von IronPDF sollte ich verwenden?: um eine Version in Ihrer Anleitungsdatei festzulegen
- Wie man IronPDF in einem Docker-Container ausführt: für die nativen Abhängigkeiten, die der Runner des Agenten benötigt
Fragen?
Wenn Sie Fragen haben, wenden Sie sich an support@ironsoftware.com.
Curtis Chau hat einen Bachelor-Abschluss in Informatik von der Carleton University und ist spezialisiert auf Frontend-Entwicklung mit Expertise in Node.js, TypeScript, JavaScript und React. Leidenschaftlich widmet er sich der Erstellung intuitiver und ästhetisch ansprechender Benutzerschnittstellen und arbeitet gerne mit modernen Frameworks sowie der Erstellung gut strukturierter, optisch ansprechender Handbücher.