Wersja 2.7.0 wprowadza cichy breaking-change

[DawidBartniczak]

Opis Problemu

Klasa InvoiceExportRequest w poprzednich wersjach definiowała pole CompressionType jako

        /// <summary>
        /// Typ kompresji paczki eksportu faktur. Domyslnie API zachowuje kompatybilnosc i uzywa ZIP.
        /// </summary>
        public CompressionType? CompressionType { get; set; }

Po zmianach z 2.7.0 jest to

        /// <summary>
        /// Typ kompresji paczki eksportu faktur. Domyslnie API zachowuje kompatybilnosc i uzywa TAR GZ.
        /// </summary>
        public CompressionType CompressionType { get; set; } = CompressionType.TarGz;

Wprowadza to znaczącą różnicę semantyczną. Wcześniej domyślny NULL powodował zwracanie paczek ZIP z domysłu, aktualnie domyślnie zwracane są paczki TarGz.

Powoduje to znaczne i trudne to wykrycia problemy w momencie kiedy dalszy kod oczekuje paczek ZIP (jakie były poprzednio zwracane). Zmiana ta, nie jest też poprawnie zakomunikowana - jest to pułapka.

[TiEmKej]

Myśle że warto aby tak jak są prowadzone changelogi na repozytorium dokumentacji, tutaj takowe też się znalazły - niech nawet AI to podsumowuje w jakiś zwięzły i krótki sposób typu "Zmieniono typy w InvoiceExportRequest" co już pomoże szybciej debugować takowe błędy

[CIRF-DEV1]

@DawidBartniczak @TiEmKej

Rejestr zmian biblioteki KSeF.Client znajduje się pod adresem https://github.com/CIRFMF/ksef-client-csharp/blob/main/.github/RELEASE_NOTES.md
W zmianach wersji 2.7.0 została umieszczona informacja o zmianie domyślnego typu kompresji eksportu faktur z Zip na TarGz.

Dla lepszej widoczności dodamy odnośnik do rejestru zmian w README.md

[TiEmKej]

@CIRF-DEV1

To ja od siebie zaproponuje żeby CHANGELOG był wpięty tutaj

[Marmelada100]

Zgadzam się z OP, takich zmian się nie robi...
Wszystko powinno być zgodne wstecz, a zmiany powinny być świadomie wprowadzone przez programistę.
Dobrze, że po stronie serwera API tego nie zrobiono, bo dopiero byłyby yaya.

[TiEmKej]

Wszystko powinno być zgodne wstecz, a zmiany powinny być świadomie wprowadzone przez programistę.

Tu sie nie zgodze. Albo nie aktualizujesz poki dziala, albo patrzysz co się zmienia. Fakt zmiana powinna byc zakomunikowana jaśniej, ale zmiany łamiące konwencje są naturalnymi zmianami.