Update the CHANGELOG and API diff

This commit is contained in:
DreamPiggy 2019-01-26 18:16:22 +08:00
parent 557b6985a8
commit bb00bf1b73
2 changed files with 62 additions and 9 deletions

View File

@ -1,3 +1,36 @@
## [5.0.0-beta4 - Customizable SDWebImage, on Jan 26th, 2019](https://github.com/rs/SDWebImage/releases/tag/5.0.0-beta4)
See [all tickets marked for the 5.0.0 release](https://github.com/rs/SDWebImage/milestone/15)
#### Features
- Expose the graphics helper method for coder plugin author and fix scale issue #2523
#### Performances
- Decrease animated decode times when cache enable #2468
- Remove kCGImageSourceShouldCache option when creating image source #2472
- Add autoreleasepool to release autorelease objects in advance when using GCD #2474
#### Fixes
- Add protect when custom animated image class image data is nil during progressive animation check #2466
- Fix background download #2500
#### Project
- Merged targets + MapKit dedicated target for Carthage installs #2476. Carthage user now does not enable MapKit support by default.
- Upgrade Xcode 10 + using xcconfig for project settings #2494
#### Notable Changes (from beta3)
Behavior:
- Move webp component (and libwebp dependency) to SDWebImage/SDWebImageWebPCoder #2469. Any user who use WebP in 5.0.0 should add [SDWebImageWebPCoder](https://github.com/SDWebImage/SDWebImageWebPCoder) to your Podfile or Cartfile instead.
- Refactory cache path about namespace && final cache directory #2535. Now the default disk cache path was moved to suitable path with the namespace.
- Use the memory bytes size, instead of pixel size to calculate the memory cost function #2568. Now the memory cost function use bytes size instead of pixels count.
Swift Only:
- Fix the accident changes of Swift API naming for `sd_imageDataAsFormat:` #2517
You can always check [5.0 migration guide](https://github.com/SDWebImage/SDWebImage/wiki/5.0-Migration-guide) for the latest information for these changes.
## [5.0.0-beta3 - Customizable SDWebImage, on Aug 30th, 2018](https://github.com/rs/SDWebImage/releases/tag/5.0.0-beta3)
See [all tickets marked for the 5.0.0 release](https://github.com/rs/SDWebImage/milestone/15)

View File

@ -227,6 +227,8 @@
<div class="difference"><span class="status removed">Removed</span> SDImageCache.maxMemoryCountLimit</div>
<div class="difference"><span class="status removed">Removed</span> -[SDImageCache makeDiskCachePath:]</div>
<div class="difference"><span class="status removed">Removed</span> -[SDImageCache addReadOnlyCachePath:]</div>
<div class="difference"><span class="status removed">Removed</span> -[SDImageCache getSize]</div>
<div class="difference"><span class="status removed">Removed</span> -[SDImageCache getDiskCount]</div>
<div class="difference"><span class="status removed">Removed</span> -[SDImageCache cachePathForKey:inPath:]</div>
<div class="difference"><span class="status removed">Removed</span> -[SDImageCache defaultCachePathForKey:]</div>
</div>
@ -247,6 +249,8 @@
<div class="difference"><span class="status added">Added</span> -[SDImageCache queryCacheOperationForKey:options:context:done:]</div>
<div class="difference"><span class="status added">Added</span> -[SDImageCache removeImageFromMemoryForKey:]</div>
<div class="difference"><span class="status added">Added</span> -[SDImageCache removeImageFromDiskForKey:]</div>
<div class="difference"><span class="status added">Added</span> -[SDImageCache totalDiskSize]</div>
<div class="difference"><span class="status added">Added</span> -[SDImageCache totalDiskCount]</div>
</div>
@ -272,6 +276,13 @@
<tr><th>To</th><td class="declaration">@property (class, nonatomic, readonly, nonnull) SDImageCache *sharedImageCache</td></tr>
</table>
<br>
<div class="difference"><span class="status modified">Modified</span> -[SDImageCache initWithNamespace:diskCacheDirectory:]</div>
<table>
<tr><th></th><th>Declaration</th></tr>
<tr><th>From</th><td class="declaration">- (nonnull instancetype)initWithNamespace:(nonnull NSString *)ns diskCacheDirectory:(nonnull NSString *)directory</td></tr>
<tr><th>To</th><td class="declaration">- (nonnull instancetype)initWithNamespace:(nonnull NSString *)ns diskCacheDirectory:(nullable NSString *)directory</td></tr>
</table>
<br>
<div class="difference"><span class="status modified">Modified</span> -[SDImageCache diskImageExistsWithKey:completion:]</div>
<table>
<tr><th></th><th>Declaration</th></tr>
@ -309,15 +320,18 @@
<div class="differenceGroup">
<div class="difference"><span class="status removed">Removed</span> SDImageCacheConfig.shouldDecompressImages</div>
<div class="difference"><span class="status removed">Removed</span> SDImageCacheConfig.maxCacheAge</div>
<div class="difference"><span class="status removed">Removed</span> SDImageCacheConfig.maxCacheSize</div>
</div>
<div class="differenceGroup">
<div class="difference"><span class="status added">Added</span> SDImageCacheConfig.defaultCacheConfig</div>
<div class="difference"><span class="status added">Added</span> SDImageCacheConfig.shouldRemoveExpiredDataWhenEnterBackground</div>
<div class="difference"><span class="status added">Added</span> SDImageCacheConfig.maxDiskAge</div>
<div class="difference"><span class="status added">Added</span> SDImageCacheConfig.maxDiskSize</div>
<div class="difference"><span class="status added">Added</span> SDImageCacheConfig.maxMemoryCost</div>
<div class="difference"><span class="status added">Added</span> SDImageCacheConfig.maxMemoryCount</div>
<div class="difference"><span class="status added">Added</span> SDImageCacheConfig.namespacePrefix</div>
<div class="difference"><span class="status added">Added</span> SDImageCacheConfig.fileManager</div>
<div class="difference"><span class="status added">Added</span> SDImageCacheConfig.memoryCacheClass</div>
<div class="difference"><span class="status added">Added</span> SDImageCacheConfig.diskCacheClass</div>
@ -332,13 +346,6 @@
<tr><th>To</th><td>NSCopying</td></tr>
</table>
<br>
<div class="difference"><span class="status modified">Modified</span> SDImageCacheConfig.maxCacheAge</div>
<table>
<tr><th></th><th>Declaration</th></tr>
<tr><th>From</th><td class="declaration">@property (nonatomic, assign) NSInteger maxCacheAge</td></tr>
<tr><th>To</th><td class="declaration">@property (nonatomic, assign) NSTimeInterval maxCacheAge</td></tr>
</table>
<br>
</div>
</div>
@ -475,6 +482,19 @@
</div>
<div class="headerFile">
<div class="headerName">SDImageGraphics.h</div>
<div class="differenceGroup">
<div class="difference"><span class="status added">Added</span> SDGraphicsGetCurrentContext()</div>
<div class="difference"><span class="status added">Added</span> SDGraphicsBeginImageContext()</div>
<div class="difference"><span class="status added">Added</span> SDGraphicsBeginImageContextWithOptions()</div>
<div class="difference"><span class="status added">Added</span> SDGraphicsEndImageContext()</div>
<div class="difference"><span class="status added">Added</span> SDGraphicsGetImageFromCurrentImageContext()</div>
</div>
</div>
<div class="headerFile">
<div class="headerName">SDImageIOCoder.h</div>
@ -563,7 +583,6 @@
<div class="headerName">SDMemoryCache.h</div>
<div class="differenceGroup">
<div class="difference"><span class="status added">Added</span> SDMemoryCacheCostForImage()</div>
<div class="difference"><span class="status added">Added</span> SDMemoryCache</div>
<div class="difference"><span class="status added">Added</span> -[SDMemoryCache initWithConfig:]</div>
<div class="difference"><span class="status added">Added</span> -[SDMemoryCache objectForKey:]</div>
@ -1283,6 +1302,7 @@
<div class="differenceGroup">
<div class="difference"><span class="status removed">Removed</span> SDWebImageInternalSetImageGroupKey</div>
<div class="difference"><span class="status removed">Removed</span> SDWebImageExternalCustomManagerKey</div>
<div class="difference"><span class="status removed">Removed</span> SDInternalSetImageBlock</div>
<div class="difference"><span class="status removed">Removed</span> -[UIView sd_internalSetImageWithURL:placeholderImage:options:operationKey:setImageBlock:progress:completed:]</div>
<div class="difference"><span class="status removed">Removed</span> -[UIView sd_internalSetImageWithURL:placeholderImage:options:operationKey:setImageBlock:progress:completed:context:]</div>
<div class="difference"><span class="status removed">Removed</span> -[UIView sd_setShowActivityIndicatorView:]</div>