merge release to master by adamhathcock · Pull Request #1174 · adamhathcock/sharpcompress

adamhathcock · 2026-01-28T11:14:33Z

This pull request includes several changes across configuration, build tooling, and the core library, focusing on improving versioning logic, stream handling, and internal diagnostics for 7z archives. The most significant updates are the removal of legacy agent and planning files, enhancements to the build versioning strategy, and improvements to stream management and diagnostics in the core archive code.

Configuration and Documentation Cleanup:

Removed .copilot-agent.yml and .github/agents/copilot-agent.yml, eliminating old Copilot agent configuration and policies. [1] [2]
Deleted two detailed planning prompt documents: .github/prompts/plan-async.prompt.md and .github/prompts/plan-for-next.prompt.md, cleaning up project documentation. [1] [2]

Build and Versioning Improvements:

Enhanced the versioning logic in build/Program.cs to increment the patch version for release branches and the minor version for other branches, with branch detection supporting both local and CI environments. [1] [2] [3]

Core Library Enhancements:

Refactored stream handling in ArchiveFactory.cs and ArchiveFactory.Async.cs by removing unnecessary wrapping with SharpCompressStream.Create, simplifying stream management for archive operations. [1] [2]
Updated IArchiveEntryExtensions.cs to use a shared Constants.BufferSize for all copy operations, ensuring consistency and maintainability. [1] [2] [3]
Changed GZipWritableArchiveEntry.cs to use NonDisposingStream instead of SharpCompressStream.Create for entry streams, improving resource handling.

SevenZip Archive Diagnostics and Internal Improvements:

Added internal diagnostics support to SevenZipArchive.SevenZipReader, exposing properties for test diagnostics and clarifying folder stream handling for solid archives. Also improved documentation and code comments for maintainability. [1] [2] [3]

API Simplification:

Simplified IsArchive methods in ArchiveFactory.cs by removing the bufferSize parameter and streamlining overloads.

These changes collectively improve code clarity, maintainability, and diagnostics, while also cleaning up obsolete configuration and documentation files.

Co-authored-by: adamhathcock <527620+adamhathcock@users.noreply.github.com>

Add [Obsolete] attribute to ReaderOptions.DefaultBufferSize for backward compatibility

Fix grammatical errors in ArcFactory comment documentation

…ement minor versions

…into adam/buffer-size-consolidation

…tion (Release) Buffer size consolidation

Co-authored-by: adamhathcock <527620+adamhathcock@users.noreply.github.com>

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…gression Fix ZIP parsing failure on non-seekable streams with short reads

Co-authored-by: adamhathcock <527620+adamhathcock@users.noreply.github.com>

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…guous-streams Fix SevenZipReader to maintain contiguous stream state for solid archives

# Conflicts: # src/SharpCompress/Archives/ArchiveFactory.cs # src/SharpCompress/Archives/AutoArchiveFactory.cs # src/SharpCompress/Archives/SevenZip/SevenZipArchive.cs # src/SharpCompress/Archives/Zip/ZipArchive.cs # src/SharpCompress/Factories/AceFactory.cs # src/SharpCompress/Factories/ArcFactory.cs # src/SharpCompress/Factories/ArjFactory.cs # src/SharpCompress/Factories/Factory.cs # src/SharpCompress/Factories/GZipFactory.cs # src/SharpCompress/Factories/IFactory.cs # src/SharpCompress/Factories/RarFactory.cs # src/SharpCompress/Factories/SevenZipFactory.cs # src/SharpCompress/Factories/TarFactory.cs # src/SharpCompress/Factories/ZStandardFactory.cs # src/SharpCompress/Factories/ZipFactory.cs # src/SharpCompress/IO/SharpCompressStream.cs # src/SharpCompress/Readers/AbstractReader.cs # src/SharpCompress/Utility.cs

kiloconnect · 2026-02-04T11:33:26Z

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Files Reviewed (8 files)

tests/SharpCompress.Test/Streams/ZLibBaseStreamAsyncTests.cs - Updated stream wrapper usage
tests/SharpCompress.Test/Streams/ZlibBaseStreamTests.cs - Updated stream wrapper usage
tests/SharpCompress.Test/TestBase.cs - Minor assertion order change
tests/SharpCompress.Test/WriterTests.cs - Updated stream wrapper usage
tests/SharpCompress.Test/Zip/ZipReaderAsyncTests.cs - Added new test and updated reader factory usage
tests/SharpCompress.Test/Zip/ZipReaderTests.cs - Added new test and updated stream wrapper usage
tests/SharpCompress.Test/Zip/ZipShortReadTests.cs - New test file for short read handling
tests/SharpCompress.Test/packages.lock.json - Removed obsolete package entries

Copilot

Pull request overview

This pull request merges the release branch to master, focusing on modernizing SharpCompress's stream handling infrastructure, improving build versioning, and cleaning up obsolete configuration. The changes replace the complex SharpCompressStream buffering system with simpler stream wrappers (NonDisposingStream, CountingStream, RewindableStream), standardize buffer sizes through Constants.BufferSize, and add async support for compression formats.

Changes:

Removed legacy Copilot agent configuration and planning documents
Enhanced build versioning to increment patch version on release branches, minor version on other branches
Refactored stream handling to remove SharpCompressStream wrapper, using simpler alternatives
Added async support for multiple compression formats (Squeezed, Reduce, Shrink, Arc, filters)
Improved 7Zip solid archive stream reuse with diagnostic support

Reviewed changes

Copilot reviewed 193 out of 193 changed files in this pull request and generated 68 comments.

Show a summary per file

File	Description
`.copilot-agent.yml`	Removed Copilot agent manifest
`.github/agents/copilot-agent.yml`	Removed detailed agent policies
`.github/prompts/plan-*.prompt.md`	Removed planning documents
`build/Program.cs`	Enhanced versioning logic with branch detection
`src/SharpCompress/Utility.Async.cs`	Added async stream extension methods using new extension syntax
`src/SharpCompress/Common/Constants.cs`	Added global buffer size constants
`src/SharpCompress/IO/*`	New stream wrappers and refactored stream handling
`src/SharpCompress/Compressors/*`	Added async support for compression formats
`tests/SharpCompress.Test/Zip/ZipShortReadTests.cs`	New tests for ZIP short read scenarios
Multiple test files	Updated to use NonDisposingStream instead of SharpCompressStream

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/SharpCompress/Utility.Async.cs

src/SharpCompress/Archives/IArchiveEntryExtensions.cs

Copilot · 2026-02-04T11:40:32Z

src/SharpCompress/Common/Tar/TarReadOnlySubStream.cs

-
-    void IStreamStack.SetPosition(long position) { }
+    private readonly Stream _stream;
+    private readonly bool _useSyncOverAsyncDispose;


The field _useSyncOverAsyncDispose is declared but never assigned a value in the constructor. This will always be false, potentially causing incorrect behavior. The constructor should accept and assign this parameter.

tests/SharpCompress.Test/Streams/RewindableStreamAsyncTest.cs

Copilot · 2026-02-04T11:40:44Z

src/SharpCompress/Compressors/PPMd/I1/Coder.cs

+    {
+        while (
+            (_low ^ (_low + _range)) < RANGE_TOP
+            || _range < RANGE_BOTTOM && ((_range = (uint)-_low & (RANGE_BOTTOM - 1)) != 0 || true)


The expression 'A || true' is always 'true'.

Copilot · 2026-02-04T11:40:45Z

src/SharpCompress/Common/Zip/WinzipAesCryptoStream.cs

    private bool _isFinalBlock;
    private long _totalBytesLeftToRead;
    private bool _isDisposed;
+    private bool _useSyncOverAsyncDispose;


Field '_useSyncOverAsyncDispose' can be 'readonly'.

Copilot · 2026-02-04T11:40:45Z

src/SharpCompress/IO/RewindableStream.cs

+    public virtual Stream BaseStream() => stream;
+
+    private readonly Stream stream;
+    private MemoryStream bufferStream = new MemoryStream();


Field 'bufferStream' can be 'readonly'.

Copilot · 2026-02-04T11:40:45Z

src/SharpCompress/Compressors/Filters/Filter.Async.cs

+        if (inSize + _read > _tail.Length)
+        {
+            _transformed = Transform(_window, 0, inSize + _read);
+        }
+        else
+        {
+            _transformed = inSize + _read;
+        }


Both branches of this 'if' statement write to the same variable - consider using '?' to express intent better.

Copilot · 2026-02-04T11:40:45Z

src/SharpCompress/Compressors/Filters/Filter.Async.cs

+        if (inSize + _read > _tail.Length)
+        {
+            _transformed = Transform(_window, 0, inSize + _read);
+        }
+        else
+        {
+            _transformed = inSize + _read;
+        }


Both branches of this 'if' statement write to the same variable - consider using '?' to express intent better.

adamhathcock and others added 30 commits January 27, 2026 10:46

Using Constants class differently

0a50386

Remove change

d52facd

Initial plan

014bbc3

Initial plan

a114155

Fix grammatical errors in ArcFactory comments

6c86632

Co-authored-by: adamhathcock <527620+adamhathcock@users.noreply.github.com>

Add [Obsolete] attribute to ReaderOptions.DefaultBufferSize

53f12d7

Co-authored-by: adamhathcock <527620+adamhathcock@users.noreply.github.com>

Add clarifying comment about buffer size value difference

010a38b

Co-authored-by: adamhathcock <527620+adamhathcock@users.noreply.github.com>

Merge pull request #1166 from adamhathcock/copilot/sub-pr-1165

d11f6ae

Add [Obsolete] attribute to ReaderOptions.DefaultBufferSize for backward compatibility

Merge pull request #1167 from adamhathcock/copilot/sub-pr-1165-again

3c88c7f

Fix grammatical errors in ArcFactory comment documentation

release branch builds increment patch versions and master builds incr…

d6156f0

…ement minor versions

Merge remote-tracking branch 'origin/adam/buffer-size-consolidation' …

f0eaddc

…into adam/buffer-size-consolidation

fmt

c82744c

constant should be a static property

4d31436

Merge pull request #1165 from adamhathcock/adam/buffer-size-consolida…

a9c28a7

…tion (Release) Buffer size consolidation

Initial plan

970934a

Fix ZIP parsing regression with short reads on non-seekable streams

a706a9d

Co-authored-by: adamhathcock <527620+adamhathcock@users.noreply.github.com>

Apply code formatting with CSharpier

71655e0

Co-authored-by: adamhathcock <527620+adamhathcock@users.noreply.github.com>

Refactor FillBuffer to use ReadFully pattern

d59e4c2

Co-authored-by: adamhathcock <527620+adamhathcock@users.noreply.github.com>

Update tests/SharpCompress.Test/Zip/ZipShortReadTests.cs

8a3be35

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Initial plan

72eaf66

Merge pull request #1169 from adamhathcock/copilot/fix-zip-parsing-re…

af08a7c

…gression Fix ZIP parsing failure on non-seekable streams with short reads

Fix SevenZipReader to iterate entries as contiguous streams

db2f5c9

Co-authored-by: adamhathcock <527620+adamhathcock@users.noreply.github.com>

Remove unused _currentFolderIndex field

999124e

Co-authored-by: adamhathcock <527620+adamhathcock@users.noreply.github.com>

Add test to verify folder stream reuse in solid archives

3c87242

Co-authored-by: adamhathcock <527620+adamhathcock@users.noreply.github.com>

Don't use reflection in tests

8a67d50

Update src/SharpCompress/Archives/SevenZip/SevenZipArchive.cs

484bc74

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Merge pull request #1172 from adamhathcock/copilot/fix-sevenzip-conti…

9a7bdd3

…guous-streams Fix SevenZipReader to maintain contiguous stream state for solid archives

fmt

f4369e5

more fixes

8d5d686

adamhathcock and others added 7 commits February 4, 2026 08:20

tests all pass

8759cf0

use ringbuffer

3ab4478

fmt

7e54f91

try to fix test

f67168f

add sync over async dispose

94716a5

another sync over async

b93ed79

fmt

7e8005a

adamhathcock marked this pull request as ready for review February 4, 2026 11:32

Copilot AI review requested due to automatic review settings February 4, 2026 11:32

Copilot started reviewing on behalf of adamhathcock February 4, 2026 11:33 View session

Copilot AI reviewed Feb 4, 2026

View reviewed changes

adamhathcock merged commit 9def35f into master Feb 4, 2026
11 checks passed

adamhathcock deleted the adam/merge-release-to-master branch February 4, 2026 12:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

merge release to master#1174

merge release to master#1174
adamhathcock merged 85 commits intomasterfrom
adam/merge-release-to-master

adamhathcock commented Jan 28, 2026 •

edited

Loading

Uh oh!

kiloconnect bot commented Feb 4, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 4, 2026

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 4, 2026

Uh oh!

Copilot AI Feb 4, 2026

Uh oh!

Copilot AI Feb 4, 2026

Uh oh!

Copilot AI Feb 4, 2026

Uh oh!

Copilot AI Feb 4, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

adamhathcock commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kiloconnect bot commented Feb 4, 2026

Code Review Summary

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

adamhathcock commented Jan 28, 2026 •

edited

Loading