Jak używać IronZIP z GitHub Copilot
.NET niektóre systemy zapisują dzienniki do jednego folderu na usługę, a ich zespół operacyjny chce, aby każdy dzień był jednym .tar.gz do kopiowania na hosta Linux i rozpakowania za pomocą tar -xzf. Zadanie, które tworzy te pakiety, należy do tego samego rozwiązania Visual Studio co usługi.
Copilot CLI może zbudować to zadanie w terminalu, Copilot Chat i tryb agenta mogą je zbudować w Visual Studio lub VS Code, a agent w chmurze może przekształcić problem GitHub na jego temat w pull request. IronZIP zapisuje i rozpakowuje TAR i GZIP z .NET, a dwa pliki instrukcji w repozytorium informują każdą powierzchnię Copilot w tym przewodniku, jak zachowują się jego wywołania TAR.
przykład tworzenia TAR, przykład tworzenia GZIP i przykład wyodrębnienia GZIP pokazują wywołania, na których opiera się ten przewodnik.
Szybki startUruchomić copilot w katalogu głównym rozwiązania i przesłać to prompt. Copilot Chat w Visual Studio nazywa pliki za pomocą #, gdzie CLI używa @.
Read @docs/bundle-format.md, then fill in @src/LogArchiver/Archiving/LogBundle.cs.
Add one public static method that works like this:
- Its signature is Create(string logsRoot, DateOnly day, string outputFolder).
- It writes the day's bundle and returns its path.
- It returns null when the day has no logs.
- It builds the TAR and the GZIP with IronZIP.
- IronZIP comes from the IronZIP package and lives in the IronZip namespace.
Change the bundle command in Program.cs to call Create.
It prints the bundle path, or the message the format document gives for a day without logs.
Run it for 2026-10-10, then list the bundle with tar -tvzf and show me the listing.
Plik instrukcji specyficzny dla ścieżki określa regułę nazewnictwa TAR IronZIP, więc prompt to pomija.
Przechowuj klucz w zmiennej środowiskowej IRONZIP_LICENSE_KEY lub w tajemnicy repozytorium, poza promptami i commitami. W sondzie, która ustawiła tylko tę zmienną, License.IsLicensed zwróciła fałsz, więc Program.cs kopiuje wartość do IronZip.License.LicenseKey. Aby ustawić klucz w pliku konfiguracyjnym, postępuj zgodnie z przewodnikiem po kluczach licencyjnych. Zostaw ochronę gałęzi i akceptację przez człowieka włączoną dla pull requestów agenta w chmurze.
Minimalny proces (5 kroków)
- Pobierz bibliotekę C# ZIP z NuGet
- Zapisz reguły TAR IronZIP w .github/copilot-instructions.md oraz w jednym pliku instrukcji specyficznym dla ścieżki
- Skopiować każdy dziennik pod jego ostateczną nazwą, zbudować TAR, a następnie opakować go w GZIP
- Rozpakować każdy pakiet do pustego folderu w testach i porównać każdy plik według SHA-256
- Złożyć następną zmianę jako problem dla agenta w chmurze i przejrzeć jego pull request korzystając z dokumentacji API
Jak ustawić konwencje IronZIP dla Copilot?
Odnośnik wsparcia GitHub wymienia .github/copilot-instructions.md dla Copilot CLI, dla agenta w chmurze i dla Copilot Chat w Visual Studio i VS Code, więc reguły paczki, licencji i testów trafiają tam. Visual Studio ignoruje plik, dopóki nie zostanie zaznaczone pole z własnymi instrukcjami w opcjach Copilot Chat.
Archive code in this repo follows these rules:
- Archive code uses IronZIP from the IronZIP NuGet package, namespace IronZip.
- Add no other compression package.
- Keep System.Formats.Tar and System.IO.Compression out of src/.
- Tests may use them to read bundles.
- Change the IronZIP version in Directory.Packages.props only for an upgrade task.
- IRONZIP_LICENSE_KEY holds the license key.
- Never put it in code, settings, tests or output, and never echo it.
- Check only that it is set.
- docs/bundle-format.md is the contract for every bundle.
- Do not edit it, and report any place where the code departs from it.
- IronZIP documentation for agents: https://ironsoftware.com/zip/csharp/llms.txt
- Find each IronZIP member in IronZip.xml in the NuGet cache before using it.
- If a member is missing there, say so.
The tests follow these rules:
- A test that calls IronZIP copies IRONZIP_LICENSE_KEY into License.LicenseKey first.
- IronZIP never reads that variable on its own.
- Write bundles into a temp folder.
- Unpack them into a second empty folder and compare files by SHA-256.
- Never compare archive bytes.
Jak nadać kodowi archiwum własne reguły?
Zapisz reguły archiwizacji jako .github/instructions/archives.instructions.md. GitHub dokumentuje, że Copilot CLI uwzględnia plik specyficzny dla ścieżki tylko wtedy, gdy jego wartość applyTo pasuje do pliku, z którym CLI pracuje. Polecenie /instructions wymienia pliki instrukcji, które CLI znalazł, i włącza lub wyłącza każdy z nich.
---
applyTo: "src/LogArchiver/**,tests/LogArchiver.Tests/**"
---
IronZIP's TAR and GZIP calls behave this way in the log archiver and its tests:
- IronTarArchive.Add keeps only the file name and drops every folder.
- Two files with one name become two entries with that name, and unpacking keeps the last.
- Copy each file into a staging folder under its final entry name and add the copy.
- IronTarArchive.Add on a folder adds nothing and throws nothing.
- A GZIP file holds one stream.
- Save the TAR first, then add that single file to an IronGZipArchive.
- Two files added to one IronGZipArchive come out as one file with both contents joined.
- GetArchiveEntryNames throws on a new archive that was never saved.
- Call it on an archive opened from a file.
- No entry can be added after SaveAs. Start a new archive instead.
- Unpack a .tar.gz with IronGZipArchive.ExtractTGZArchiveToDirectory.
- Always unpack into a new empty folder.
- Unpacking replaces files of the same name and leaves every other file where it was.
- IronTarArchive.ExtractArchiveToDirectory writes an entry named ../x or /x outside the target.
- Check every name from GetArchiveEntryNames first.
- Without a key, IronTarArchive.Add throws LicensingException.
- SaveAs then still writes an empty archive.
- Never catch that exception and continue.
Co zapisuje TAR IronZIP z ścieżki pliku?
Każda usługa tutaj nadaje swoim dziennikom nazwę po dacie, więc logs/api/2026-10-10.log i logs/worker/2026-10-10.log dzielą nazwę pliku. Dodane bezpośrednio z ich folderów za pomocą IronZIP 2026.10.2, cztery dzienniki dla 10 października stały się czterema wpisami TAR nazwanymi 2026-10-10.log. tar -tvzf wymienił wszystkie cztery, i nic nie zgłosiło błędu. Rozpakowany za pomocą IronZIP, pakiet zawierał jeden 2026-10-10.log o rozmiarze 19 813 bajtów, ostatnio dodany dziennik worker.
Z każdym dziennikiem zestrojonym jako kopia nazwana dla jego usługi, taką jak worker-2026-10-10.log, pakiety dla 10 i 9 października oraz pusty 8 października przeszły wszystkie 24 testy sprawdzarki formatu Python, która czyta pakiety bez IronZIP. Każdy wpis miał tryb 700, właściciela 0 i czas zapisu, a nie własny znacznik czasu pliku. Dwa pakiety tych samych dzienników stworzone dwie sekundy później różniły się od piątego bajtu, gdzie GZIP przechowuje swój czas.
Jak sprawdzić pakiet po jego zapisaniu?
Wskazany na używany folder, ExtractTGZArchiveToDirectory zastępuje pliki tej samej nazwy i zachowuje resztę, więc sprawdzenie ponownie używanego folderu może zliczyć przestarzały plik.
Add a verify <bundle> command to Program.cs beside bundle.
The command runs these steps in order:
1. Unpack the bundle with IronZIP into a fresh temp folder.
2. Read manifest.txt there.
3. Confirm the folder holds manifest.txt plus exactly the files it names.
4. Confirm those files have matching sizes and SHA-256 hashes.
It reports the outcome this way:
- Print one line for each problem, and exit 1 if there is one.
- If there is none, print the file count and exit 0.
- If IronZIP cannot unpack the bundle, print its exception and exit 1.
- Delete the temp folder either way.
Run verify on the 2026-10-10 bundle.
Then run it on a copy of that bundle in a temp folder with the middle byte flipped.
Show me both results.
W sondzie kalibracyjnej, odwrócony bajt sprawił, że IronZIP zgłosił TarException ("Suma kontrolna nagłówka jest nieprawidłowa") po zapisaniu pierwszego dziennika, więc nieudane rozpakowanie może zostawić częściowy folder.
Jak przetestować pakiet IronZIP?
Test, który czyta każdy pakiet za pomocą System.Formats.Tar oraz IronZIP wychwytuje błąd nazewnictwa, który IronZIP rozpakowanie ukrywa. Odnośnik CLI GitHub mówi, że /plan rozpoczyna sesję planowania, w której Copilot CLI może eksplorować kod, ale jest zablokowany przed edytowaniem plików projektu.
/plan an xUnit suite in tests/LogArchiver.Tests for LogBundle.Create.
Each test copies the logs folder to a temp directory and writes its bundles there.
Read each bundle back in two ways:
- unpacked by IronZIP into an empty folder
- listed with System.Formats.Tar over a GZipStream, which needs no IronZIP
The suite shows each of these points:
- The 2026-10-10 bundle has one top-level entry per service log plus manifest.txt.
- No entry name is repeated.
- Each unpacked log matches its source by SHA-256.
- The rotated .log.1 file and other days are left out.
- A day without logs writes nothing.
- Only the bundle remains in the output folder.
After I approve the plan, write the tests and run them with dotnet test.
Tell me how many passed and how many failed.
Dlaczego przywracanie starego TAR zapisuje poza swoim folderem?
Pakiety sprzed 2026 roku to zwykłe pliki TAR, a polecenie przywracania kolegi rozpakowuje je za pomocą IronTarArchive.ExtractArchiveToDirectory. W sondzie, to wywołanie zapisało wpis nazwany ../escaped-dotdot.txt do folderu powyżej celu, i jeden z absolutną nazwą do korzenia dysku. ExtractTGZArchiveToDirectory odmówił tego samego wpisu ../ z InvalidNameException, choć dopiero po rozpakowaniu wcześniejszych wpisów.
Commit konfiguracji dodaje RestoreCommand.cs, RestoreTests.cs i dwa pliki TAR w TestData/restore.
A teammate added @src/LogArchiver/Archiving/RestoreCommand.cs.
It restores the plain .tar archives kept from before 2026.
RestoreTests now fails on TestData/restore/hostile.tar.
Before changing any code, do these three things:
1. Run that test.
2. Print the entry names IronZIP reports for both .tar files in TestData/restore.
3. Explain how a file ends up outside the target folder.
Then fix it in RestoreCommand.cs alone.
An archive with any entry that would be written outside the target must be refused.
Refuse it before a single file is written.
Leave TestData and the tests untouched.
Run dotnet test and report the result.
Poprawka odniesienia napisana do kalibracji odczytywała nazwy za pomocą GetArchiveEntryNames, odmówiła wszystkim, które rozwiązały się poza celem, i przeszła oba testy przywracania.
Co sprawia, że temat jest działaniem, które agent chmurowy może realizować?
Agent w chmurze widzi tytuł, opis, istniejące komentarze i dodatkowe instrukcje przypisanego problemu. GitHub mówi, że agent nie widzi komentarzy dodanych po przypisaniu, więc test akceptacji idzie do ciała problemu.
Title: Write a .tar.bz2 copy of each bundle for cold storage
This issue touches the following:
- Files: src/LogArchiver/Archiving/LogBundle.cs, tests/LogArchiver.Tests
- IronZIP version: whatever Directory.Packages.props pins
- Target framework: .NET 9
After the change, the bundle command behaves like this:
- bundle <date> also writes out/cold/logs-<date>.tar.bz2.
- That file holds the same TAR as the .tar.gz.
- The pull request text proposes the matching docs/bundle-format.md rule.
- That rule goes in a separate pull request.
Today, cold storage bills by size and receives the .tar.gz only.
The work stays inside these limits:
- Build the TAR once and compress that one file twice.
- Use IronGZipArchive and IronBZip2Archive for the two copies.
- Keep the .tar.gz unchanged.
- No new packages.
The issue is done when these checks pass:
- dotnet test passes.
- A new test unpacks the .tar.bz2 with IronBZip2Archive.ExtractArchiveToDirectory.
- It unpacks into an empty folder.
- It finds every log and manifest.txt identical to the .tar.gz contents.
IronBZip2Archive nie przyjmuje poziomu kompresji, a jego ExtractArchiveToDirectory rozpakowało .tar.bz2 prosto do plików wewnątrz TAR.
Dlaczego testy agenta w chmurze nie działają na projekcie IronZIP?
Agent w chmurze działa domyślnie na Ubuntu Linux. IronZIP dostarcza jedną asemblerię .NET Standard 2.0 i ani jego paczka, ani IronSoftware.Common, jego jedno zależne, nie zawierają natywnego binarnego, więc przywracanie to wszystko, czego potrzebuje uruchamiacz. Bez tajemnicy Agentów, IRONZIP_LICENSE_KEY nie jest ustawione na uruchamiaczu. Bez klucza, IronTarArchive.Add zgłosił LicensingException z "Wymagana licencja produkcyjna", a SaveAs na tym samym archiwum nadal zapisało 10 240-bajtowy TAR bez wpisów. Kod, który przechwytuje wyjątek i kontynuuje, zapisuje puste pakiety.
Copilot zaczyna pracę po zakończeniu zadania copilot-setup-steps, a GitHub uruchamia to zadanie tylko wtedy, gdy .github/workflows/copilot-setup-steps.yml jest obecne na domyślnej gałęzi.
Write the cloud agent's setup file, .github/workflows/copilot-setup-steps.yml.
The file holds one job with these settings:
- Name the job copilot-setup-steps.
- Give it contents: read.
- Run it on workflow_dispatch plus pull requests that edit this file.
The job runs these steps in order:
1. Fetch the repository.
2. Set up the .NET 9 SDK.
3. Restore.
4. Build the solution in Release.
5. Print tar --version, since the agent can compare its bundles with GNU tar.
6. Print a warning that names IRONZIP_LICENSE_KEY when that variable is empty.
IronZIP will not add entries without the key, which is why step 6 warns.
Step 6 always exits 0.
Print the YAML.
Zapisz klucz na karcie Agentów w Secretach i zmiennych, w sekcji Bezpieczeństwo w Ustawieniach repozytorium, ponieważ agent w chmurze nie może widzieć tajemnic Akcji, Codespaces ani Dependabot.
Co należy sprawdzić przed scaleniem?
Dokumentacja GitHub pokazuje /review przekazany do copilot -p, więc przegląd odbywa się we własnej sesji, oddzielnie od sesji kodowania.
/review every commit after the first on this branch.
Compare those commits with docs/bundle-format.md and the two instruction files in .github.
Report each of these:
- an IronTarArchive.Add whose path does not already end in the final entry name
- a GetArchiveEntryNames on an archive that was never saved or opened
- an Add after SaveAs
- any unpacking into a folder that may hold files already
- an IronTarArchive.ExtractArchiveToDirectory without a check of every entry name first
- a catch that could hide a LicensingException
- an IronZIP member absent from IronZip.xml in the NuGet cache
Give the file and line of each finding, and modify nothing.
Co wyprodukowały zapytania w rzeczywistym uruchomieniu?
Copilot CLI otrzymał sześć promptów w kolejności, bez nadzoru, pierwsze pięć w jednej sesji, a prompt przeglądu w osobnym wywołaniu copilot -p. Celem było rozwiązanie logów .NET 9 stworzone dla tego przewodnika, z siedmioma dziennikami w czterech usługach, pracą konsolową, która tylko je liczy, projektem xUnit pustym i dokumentem formatu. Każda liczba poniżej poza ustaleniami przeglądu i ostatnim punktem pochodzi z testów uruchamianych po zakończeniu sesji. Prompt akceptacji w przewodniku po asystentach kodowania AI sprawdza archiwa ZIP i .tgz na dwa te same sposoby, przez różne nazwy wpisów i przez SHA-256 po wyodrębnieniu.
- Sprawdzarka formatu przeszła 2 z 4 testów na nietkniętym zadaniu, które nie napisało pakietu.
- Po pierwszym promptcie sprawdzarka przeszła 24 z 24 testów dla 10, 9 i 8 października.
- Pakiet dla 10 października zawierał pięć wpisów, cztery dzienniki pod nazwami prefiksowaną usługą i manifest.txt.
- Sprawdzarka nadal przeszła 24 z 24 po ostatnim promptcie.
- Na pakiecie z 10 października, polecenie weryfikacji zliczyło 4 dzienniki i zakończyło się 0.
- Kopia z odwróconym środkowym bajtem sprawiła, że polecenie zakończyło się 1 na TarException.
- Żadne z uruchomień polecenia nie zostawiło folderu tymczasowego.
- Oba testy planowanego zestawu przeszły.
- Jeden z tych testów nie przeszedł na kopii ostatniego kodu, która dodała dzienniki bezpośrednio z ich folderów usług.
- Commit konfiguracji zostawił testy przywracania z 1 zaliczonym i 1 nie zaliczonym, a hostile.tar nie zgłosiło błędu.
- Prompt przywracania zmienił RestoreCommand.cs i żaden inny plik.
- Oba testy przywracania przeszły po tym promptcie.
- Workflow konfiguracji zinterpretowany jako jeden job copilot-setup-steps z 6 krokami, z ostatnim sprawdzeniem klucza.
- Ostateczna kompilacja Release zakończyła się z 0 ostrzeżeniami i 0 błędami.
- Przegląd zostawił każdy plik niezmieniony i zgłosił trzy ustalenia, jedno z nich przywracało do folderu, który kod nigdy nie sprawdził, czy był pusty.
- Niektóre kroki uruchomiono inaczej niż na stronie. Prompt planu uruchomiony w trybie planowania z autopilotem, więc Copilot CLI zatwierdził własny plan. Testy czytają nazwy wpisów za pomocą System.Formats.Tar i porównują hashe na plikach rozpakowanych przez IronZIP. Własna uszkodzona kopia Copilot CLI miała jeden bit odwrócony, rozpakowana bez wyjątku i nie zdała na trzech niespójnościach SHA-256. Problem, agent w chmurze, workflow konfiguracji na Akcjach i tajemnica Agentów wymagają repozytorium GitHub, więc żadne z nich nie zostało uruchomione.
Przewodnik po Kursorach przenosi kod pakietu ZIP do IronZIP, gdzie Add również usuwa folder z każdej nazwy wpisu, a jego przeniesiony pakiet zawierał 7 wpisów, każdy pod unikalną płaską nazwą. Przewodnik Google Antigravity również sprawdza każde archiwum, wyodrębniając je za pomocą IronZIP i porównując każdy plik według SHA-256. rekord wspólny uruchomienia wymienia wersję Copilot CLI, model, czas uruchomienia i maszynę testową dla tego przewodnika.
Rozwiązywanie problemów
- Tworzenie TAR dla dodawania plików do archiwum TAR
- Tworzenie GZIP dla kompresji ukończonego TAR
- Wyodrębnianie GZIP dla rozpakowywania .tar.gz w jednym wywołaniu
- Wyodrębnianie TAR dla rozpakowywania zwykłego TAR
- Klucze licencyjne IronZIP, gdy test zgłasza LicensingException
Pytania?
Jeśli są jakiekolwiek pytania, należy skontaktować się z support@ironsoftware.com
Curtis Chau posiada tytuł licencjata z informatyki (Uniwersytet Carleton) i specjalizuje się w front-endowym rozwoju, z ekspertką w Node.js, TypeScript, JavaScript i React. Pasjonuje się tworzeniem intuicyjnych i estetycznie przyjemnych interfejsów użytkownika, Curtis cieszy się pracą z nowoczesnymi frameworkami i tworzeniem dobrze zorganizowanych, atrakcyjnych wizualnie podręczników.