Prepping 4.0.0 Release (#397)

* Added release notes to the CHANGELOG and bumped podspec

* Regenerate jazzy docs for 4.0.0 release

AlamofireImage.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name = 'AlamofireImage'
-  s.version = '4.0.0-beta.6'
+  s.version = '4.0.0'
   s.license = 'MIT'
   s.summary = 'AlamofireImage is an image component library for Alamofire'
   s.homepage = 'https://github.com/Alamofire/AlamofireImage'

CHANGELOG.md

@@ -3,6 +3,7 @@ All notable changes to this project will be documented in this file.
 `AlamofireImage` adheres to [Semantic Versioning](http://semver.org/).
 
 #### 4.x Releases
+- `4.0.0` - [4.0.0](#400)
 - `4.0.0` Betas - [4.0.0-beta.1](#400-beta1) | [4.0.0-beta.2](#400-beta2) | [4.0.0-beta.3](#400-beta3) | [4.0.0-beta.4](#400-beta4) | [4.0.0-beta.5](#400-beta5) | [4.0.0-beta.6](#400-beta6)
 
 #### 3.x Releases
@@ -30,6 +31,52 @@ All notable changes to this project will be documented in this file.
 
 ---
 
+## [4.0.0](https://github.com/Alamofire/AlamofireImage/releases/tag/4.0.0)
+Released on 2020-02-23. All issues associated with this milestone can be found using this
+[filter](https://github.com/Alamofire/AlamofireImage/milestone/23?closed=1).
+
+#### Added
+- Custom `cacheKey` support to `ImageDownloader` and `UIImageView` and `UIButton` extensions. 
+  - Added by [Måns Severin](https://github.com/graphiclife) in Pull Request [#324](https://github.com/Alamofire/AlamofireImage/pull/324) in regards to Issue [#222](https://github.com/Alamofire/AlamofireImage/issues/222).
+- The `application/octet-stream` to the list of acceptable image content types to support iOS 13.
+  - Added by [Rafael Costa](https://github.com/rafaelc0sta) in Pull Request [#390](https://github.com/Alamofire/AlamofireImage/pull/390) in regards to Issues [#370](https://github.com/Alamofire/AlamofireImage/issues/370) and [#378](https://github.com/Alamofire/AlamofireImage/issues/378).
+- Custom `ImageResponseSerializer` support to `ImageDownloader` and `UIImageView` and `UIButton` extensions.
+  - Added by [Christian Noon](https://github.com/cnoon) in regards to Issues [#277](https://github.com/Alamofire/AlamofireImage/issues/277) and [#332](https://github.com/Alamofire/AlamofireImage/issues/332).
+- Tests to various types to verify they can handle `URLRequestConvertible` types that throw.
+  - Added by [Marina Gornostaeva](https://github.com/hybridcattt) in Pull Request [#392](https://github.com/Alamofire/AlamofireImage/pull/392).
+- `AlamofireExtended` support to `UIImage`, `UIImageView`, and `UIButton` types to use `af.` prefixing instead of `af_`.
+  - Added by [Christian Noon](https://github.com/cnoon) in Pull Request [#394](https://github.com/Alamofire/AlamofireImage/pull/394) in regards to Issue [#197](https://github.com/Alamofire/AlamofireImage/issues/197).
+- A 4.0 migration guide to the project and linked in the README.
+  - Added by [Christian Noon](https://github.com/cnoon) in Pull Request [#395](https://github.com/Alamofire/AlamofireImage/pull/395).
+- SwiftFormat support to the project.
+  - Added by [Jon Shier](https://github.com/jshier) in Pull Request [#396](https://github.com/Alamofire/AlamofireImage/pull/396).
+
+#### Updated
+- The license section of the README to link to the actual LICENSE file.
+  - Updated by [Yunsu Guk](https://github.com/krgoodnews) in Pull Request [#364](https://github.com/Alamofire/AlamofireImage/pull/364).
+- The `ImageDownloader` download image logic by removing variable shadowing to simplify logic flow.
+  - Updated by [Marina Gornostaeva](https://github.com/hybridcattt) in Pull Request [#392](https://github.com/Alamofire/AlamofireImage/pull/392).
+- The image cache capacity section in the README to improve in-memory setting recommendations.
+  - Updated by [Christian Noon](https://github.com/cnoon) in regards to Issue [#330](https://github.com/Alamofire/AlamofireImage/issues/330).
+- The Alamofire dependency to `~> 5.0` across dependency management files.
+  - Updated by [Christian Noon](https://github.com/cnoon).
+- The README to match all the newer conventions with the Alamofire 5 changes and `af.` prefixing on extensions.
+  - Updated by [Christian Noon](https://github.com/cnoon).
+
+#### Deprecated
+- The `af_` APIs on `UIImage`, `UIImageView`, and `UIButton` in favor of the new `af.` equivalent APIs. These APIs will be removed in AFI5.
+  - Deprecated by [Christian Noon](https://github.com/cnoon) in Pull Request [#394](https://github.com/Alamofire/AlamofireImage/pull/394).
+
+#### Fixed
+- Issue in the README where the documentation link was incorrect.
+  - Fixed by [Will Jessop](https://github.com/spnkr) in Pull Request [#367](https://github.com/Alamofire/AlamofireImage/pull/367).
+- Issue where `af_setBackgroundImage` was not setting the filter correctly on the image download.
+  - Fixed by [Dan Koza](https://github.com/djk12587) in Pull Request [#260](https://github.com/Alamofire/AlamofireImage/pull/260).
+- Issue where `runImageTransitionIfCached` on `UIImageView` was not setting the placeholder image correctly.
+  - Fixed by [Christian Noon](https://github.com/cnoon) in regards to Issue [#293](https://github.com/Alamofire/AlamofireImage/issues/293).
+
+---
+
 ## [4.0.0-beta.6](https://github.com/Alamofire/AlamofireImage/releases/tag/4.0.0-beta.6)
 Released on 2019-10-27. All issues associated with this milestone can be found using this
 [filter](https://github.com/Alamofire/AlamofireImage/milestone/35?closed=1).

docs/Classes.html

@@ -23,7 +23,7 @@
         <a class="header-link" href="index.html">
           AlamofireImage Docs
         </a>
-         (85% documented)
+         (77% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -87,6 +87,9 @@
           <li class="nav-group-name">
             <a class="nav-group-name-link" href="Extensions.html">Extensions</a>
             <ul class="nav-group-tasks">
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="Extensions/AlamofireExtension.html">AlamofireExtension</a>
+              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="Extensions/DataRequest.html">DataRequest</a>
               </li>
@@ -202,7 +205,7 @@
       <article class="main-content">
 
         <section class="section">
-          <div class="section-content">
+          <div class="section-content top-matter">
             <h1>Classes</h1>
             <p>The following classes are available globally.</p>
 
@@ -244,10 +247,6 @@ <h4>Declaration</h4>
                     </section>
                   </div>
                 </li>
-              </ul>
-            </div>
-            <div class="task-group">
-              <ul class="item-container">
                 <li class="item">
                   <div>
                     <code>
@@ -279,10 +278,6 @@ <h4>Declaration</h4>
                     </section>
                   </div>
                 </li>
-              </ul>
-            </div>
-            <div class="task-group">
-              <ul class="item-container">
                 <li class="item">
                   <div>
                     <code>
@@ -316,10 +311,6 @@ <h4>Declaration</h4>
                     </section>
                   </div>
                 </li>
-              </ul>
-            </div>
-            <div class="task-group">
-              <ul class="item-container">
                 <li class="item">
                   <div>
                     <code>
@@ -356,8 +347,8 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-10-27)</p>
-      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+      <p>&copy; 2020 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2020-02-23)</p>
+      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>
 </div>

docs/Classes/AutoPurgingImageCache.html

@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           AlamofireImage Docs
         </a>
-         (85% documented)
+         (77% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -87,6 +87,9 @@
           <li class="nav-group-name">
             <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
             <ul class="nav-group-tasks">
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Extensions/AlamofireExtension.html">AlamofireExtension</a>
+              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Extensions/DataRequest.html">DataRequest</a>
               </li>
@@ -202,7 +205,7 @@
       <article class="main-content">
 
         <section class="section">
-          <div class="section-content">
+          <div class="section-content top-matter">
             <h1>AutoPurgingImageCache</h1>
               <div class="declaration">
                 <div class="language">
@@ -224,9 +227,11 @@ <h1>AutoPurgingImageCache</h1>
               <div class="task-name-container">
                 <a name="/Properties"></a>
                 <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
-                <a href="#/Properties">
-                  <h3 class="section-name">Properties</h3>
-                </a>
+                <div class="section-name-container">
+                  <a class="section-name-link" href="#/Properties"></a>
+                  <h3 class="section-name"><p>Properties</p>
+</h3>
+                </div>
               </div>
               <ul class="item-container">
                 <li class="item">
@@ -317,9 +322,11 @@ <h4>Declaration</h4>
               <div class="task-name-container">
                 <a name="/Initialization"></a>
                 <a name="//apple_ref/swift/Section/Initialization" class="dashAnchor"></a>
-                <a href="#/Initialization">
-                  <h3 class="section-name">Initialization</h3>
-                </a>
+                <div class="section-name-container">
+                  <a class="section-name-link" href="#/Initialization"></a>
+                  <h3 class="section-name"><p>Initialization</p>
+</h3>
+                </div>
               </div>
               <ul class="item-container">
                 <li class="item">
@@ -393,9 +400,11 @@ <h4>Return Value</h4>
               <div class="task-name-container">
                 <a name="/Add%20Image%20to%20Cache"></a>
                 <a name="//apple_ref/swift/Section/Add Image to Cache" class="dashAnchor"></a>
-                <a href="#/Add%20Image%20to%20Cache">
-                  <h3 class="section-name">Add Image to Cache</h3>
-                </a>
+                <div class="section-name-container">
+                  <a class="section-name-link" href="#/Add%20Image%20to%20Cache"></a>
+                  <h3 class="section-name"><p>Add Image to Cache</p>
+</h3>
+                </div>
               </div>
               <ul class="item-container">
                 <li class="item">
@@ -532,9 +541,11 @@ <h4>Parameters</h4>
               <div class="task-name-container">
                 <a name="/Remove%20Image%20from%20Cache"></a>
                 <a name="//apple_ref/swift/Section/Remove Image from Cache" class="dashAnchor"></a>
-                <a href="#/Remove%20Image%20from%20Cache">
-                  <h3 class="section-name">Remove Image from Cache</h3>
-                </a>
+                <div class="section-name-container">
+                  <a class="section-name-link" href="#/Remove%20Image%20from%20Cache"></a>
+                  <h3 class="section-name"><p>Remove Image from Cache</p>
+</h3>
+                </div>
               </div>
               <ul class="item-container">
                 <li class="item">
@@ -741,9 +752,11 @@ <h4>Return Value</h4>
               <div class="task-name-container">
                 <a name="/Fetch%20Image%20from%20Cache"></a>
                 <a name="//apple_ref/swift/Section/Fetch Image from Cache" class="dashAnchor"></a>
-                <a href="#/Fetch%20Image%20from%20Cache">
-                  <h3 class="section-name">Fetch Image from Cache</h3>
-                </a>
+                <div class="section-name-container">
+                  <a class="section-name-link" href="#/Fetch%20Image%20from%20Cache"></a>
+                  <h3 class="section-name"><p>Fetch Image from Cache</p>
+</h3>
+                </div>
               </div>
               <ul class="item-container">
                 <li class="item">
@@ -864,9 +877,11 @@ <h4>Return Value</h4>
               <div class="task-name-container">
                 <a name="/Image%20Cache%20Keys"></a>
                 <a name="//apple_ref/swift/Section/Image Cache Keys" class="dashAnchor"></a>
-                <a href="#/Image%20Cache%20Keys">
-                  <h3 class="section-name">Image Cache Keys</h3>
-                </a>
+                <div class="section-name-container">
+                  <a class="section-name-link" href="#/Image%20Cache%20Keys"></a>
+                  <h3 class="section-name"><p>Image Cache Keys</p>
+</h3>
+                </div>
               </div>
               <ul class="item-container">
                 <li class="item">
@@ -939,8 +954,8 @@ <h4>Return Value</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-10-27)</p>
-      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+      <p>&copy; 2020 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2020-02-23)</p>
+      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>
 </div>