shrine 2.19.3 → 3.6.0

data/CHANGELOG.md

@@ -1,22 +1,504 @@
-## 2.19.3 (2019-08-09)
+## 3.6.0 (2024-04-29)
 
-* `store_dimensions` – Ignore dimensions extraction errors by default (@janko)
+* Add Rack 3 support (@tomasc, @janko)
 
-* `file_system` – Un-deprecate `FileSystem#upload` receiving unrecognized options (@janko)
+* Make a copy of attacher context hash when duplicating the attacher (@reidab)
 
-## 2.19.2 (2019-07-25)
+* An uploaded file can be implicitly re-opened after it has been closed (@jrochkind)
 
-* `default_url_options` – Allow deleting passed options when using a block (@janko)
+* Add new `:copy_options` for initializing the S3 storage (@hkdahal)
 
-* `activerecord` – Make it work with ActiveRecord 3 (@texpert)
+## 3.5.0 (2023-07-06)
 
-* `infer_extension` – Fix compatibility with `pretty_location` plugin (@janko)
+* Migrate website to Docusaurus v2 (@janko)
 
-## 2.19.1 (2019-07-20)
+* `download_endpoint` – Return `400 Bad Request` response when serialized file component is invalid (@janko)
 
-* Bring back support for Ruby 2.3 (@janko)
+* `base` – Stop using obsolete `URI.regexp` in `UploadedFile#extension` (@y-yagi)
 
-## 2.19.0 (2019-07-18)
+* `s3` – Add `:encoding` option to `S3#open` to be passed to `Down::ChunkedIO#initialize` (@pond)
+
+* `s3` – Add `:max_multipart_parts` option for changing default limit of 10,000 parts (@jpl)
+
+* `s3` – Don't inherit S3 object tags when copying from temporary to permanent storage (@jrochkind)
+
+* `infer_extension` – Add `infer_extension` instance method to the uploader for convenience (@aried3r)
+
+* `derivation_endpoint` – Add `:signer` plugin option for providing a custom URL signer (@thibaudgg)
+
+* `derivatives` – Don't leak `versions_compatibility: true` setting into other uploaders (@janko)
+
+* `derivatives` – Add `:mutex` plugin option for skipping mutex and making attacher marshallable (@janko)
+
+* `remove_attachment` – Fix passing boolean values being broken in Ruby 3.2 (@janko)
+
+* `model` – When duplicating a record, make the duplicated attacher reference the duplicated record (@janko)
+
+## 3.4.0 (2021-06-14)
+
+* `base` – Fix passing options to `Shrine.Attachment` on Ruby 3.0 (@lucianghinda)
+
+* `determine_mime_type` – Return correct `image/svg+xml` MIME type for SVGs with `:fastimage` analyzer (@Bandes)
+
+* `activerecord` – Fix keyword argument warning when adding errors with options (@janko)
+
+* `entity` – Make `Attacher#read` method public (@janko)
+
+* `entity` – Reset attachment dirty tracking in `Attacher#reload` (@janko)
+
+* `activerecord` – Don't load the attacher on `ActiveRecord::Base#reload` if it hasn't yet been initialized (@janko)
+
+* `sequel` – Don't load the attacher on `Sequel::Model#reload` if it hasn't yet been initialized (@janko)
+
+## 3.3.0 (2020-10-04)
+
+* `s3` - Support new `Aws::S3::EncryptionV2::Client` for client-side encryption (@janko)
+
+* `derivation_endpoint` – Reduce possibility of timing attacks when comparing signatures (@esparta)
+
+* `derivatives` – Avoid downloading the attached file when calling default no-op processor (@janko)
+
+* `derivatives` – Add `:download` processor setting for skipping downloading source file (@jrochkind, @janko)
+
+* `derivatives` – Copy non-file source IO objects into local file before passing them to the processor (@jrochkind)
+
+* `sequel` – Call `Attacher#reload` in `Sequel::Model#reload`, which keeps rest of attacher state (@janko, @jrochkind)
+
+* `activerecord` – Call `Attacher#reload` in `ActiveRecord::Base#reload`, which keeps rest of attacher state (@janko, @jrochkind)
+
+* `add_metadata` – Add `:skip_nil` option for excluding metadata keys whose values are nil (@renchap)
+
+* `store_dimensions` – Add `:auto_extraction` option for disabling automatically extracting dimensions on upload (@renchap)
+
+* `mirroring` – Forward original upload options when mirroring upload (@corneverbruggen)
+
+* `derivation_endpoint` – Apply `version` URL option in derivation endpoint (@janko)
+
+* `remove_attachment` – Delete removed file if a new file was attached right after removal (@janko)
+
+* `upload_endpoint` – Fix `Shrine.upload_response` not working in a Rails controller (@pldavid2)
+
+* `presign_endpoint` – Add `OPTIONS` route that newer versions of Uppy check (@janko)
+
+* `derivatives` – Add `:create_on_promote` option for auto-creating derivatives on promotion (@janko)
+
+* `s3` – Add back support for client-side encryption (@janko)
+
+* `memory` – Ensure `Memory#open` returns content in original encoding (@jrochkind)
+
+## 3.2.2 (2020-08-05)
+
+* `s3` – Fix `S3#open` not working on aws-sdk-core 3.104 and above (@janko)
+
+## 3.2.1 (2020-01-12)
+
+* `derivation_endpoint` – Use `Rack::Files` constant on Rack >= 2.1 (@janko)
+
+* Fix Ruby 2.7 warnings regarding separation of positional and keyword arguments (@janko)
+
+* `s3` – Make `S3#open` handle empty S3 objects (@janko)
+
+## 3.2.0 (2019-12-17) [[release notes]](https://shrinerb.com/docs/release_notes/3.2.0)
+
+* `validation` – Run validation on `Attacher#attach` & `Attacher#attach_cached` instead of `Attacher#change` (@janko)
+
+* `remove_invalid` – Activate also when `Attacher#validate` is run manually (@janko)
+
+* `remove_invalid` – Fix incompatibility with `derivatives` plugin (@janko)
+
+* `type_predicates` – Add new plugin with convenient `UploadedFile` predicate methods based on MIME type (@janko)
+
+* `core` – Allow assigning back current attached file data (@janko)
+
+* `derivatives` – Fix `:derivative` value inconsistency when derivatives are being promoted (@janko)
+
+* `add_metadata` – Add `#add_metadata` method for adding metadata to uploaded files (@janko)
+
+* `derivatives` – Add `:io` and `:attacher` values to instrumentation event payload (@janko)
+
+## 3.1.0 (2019-11-15) [[release notes]](https://shrinerb.com/docs/release_notes/3.1.0)
+
+* `default_storage` – Coerce storage key to symbol in `Attacher#cache_key` & `Attacher#store_key` (@janko)
+
+* `core` – Coerce storage key to symbol in `Attacher#cache_key` & `Attacher#store_key` (@janko)
+
+* `add_metadata` – Define metadata methods only for the target uploader class (@janko)
+
+* `derivatives` – Add `:storage` option to `Attacher#create_derivatives` (@janko)
+
+* `store_dimensions` – Propagate exceptions on loading `ruby-vips` in `:vips` analyzer (@janko)
+
+* `signature` – Allow skipping rewinding by passing `rewind: false` to `Shrine.signature` (@janko)
+
+* `derivatives` – Add `Attacher.derivatives` alias for `Attacher.derivatives_processor` (@janko)
+
+## 3.0.1 (2019-10-17) [[release notes]](https://shrinerb.com/docs/release_notes/3.0.1)
+
+* `metadata_attributes` – Fix exception being raised when there is no attached file (@janko)
+
+* `core` – Simplify `UploadedFile#inspect` output (@janko)
+
+## 3.0.0 (2019-10-14) [[release notes]](https://shrinerb.com/docs/release_notes/3.0.0)
+
+* `derivation_endpoint` – Pass `action: :derivation` when uploading derivation results (@janko)
+
+* `core` – Add `Shrine::Attachment[]` shorthand for `Shrine::Attachment.new` (@janko)
+
+* `core` – Add `Storage#delete_prefixed` method for deleting all files in specified directory (@jrochkind)
+
+* `linter` – Return `true` in `Storage::Linter#call` so that it can be used with `assert` (@jrochkind)
+
+* `linter` – Allow `Storage::Linter` to accept a key that will be used for testing nonexistent file (@janko)
+
+* `core` – Infer file extension from `filename` metadata (@janko)
+
+* `pretty_location` – Add `:class_underscore` option for underscoring class name (@Uysim)
+
+* Update `down` dependency to `~> 5.0` (@janko)
+
+* `multi_cache` – Add new plugin for whitelisting additional temporary storages (@janko, @jrochkind)
+
+* `sequel` – Extract callback code into attacher methods that can be overridden (@janko)
+
+* `activerecord` – Extract callback code into attacher methods that can be overridden (@janko)
+
+* `derivation_endpoint` – Stop re-opening `File` objects returned in derivation result (@janko)
+
+* `derivation_endpoint` – Allow only `File` or `Tempfile` object as derivation result (@janko)
+
+* `download_endpoint` – Add `Shrine.download_response` for calling in controller (@janko)
+
+* `core` – Fetch storage object lazily in `Shrine` instance (@janko)
+
+* `mirroring` – Add new plugin for replicating uploads and deletes to other storages (@janko)
+
+* `sequel` – Rename `:callbacks` option to `:hooks` (@janko)
+
+* `model` – Add `Attacher#set_model` for setting model without loading attachment (@janko)
+
+* `entity` – Add `Attacher#set_entity` for setting entity without loading attachment (@janko)
+
+* `entity` – Define `#<name>_attacher` class method when including `Shrine::Attachment` (@janko)
+
+* `derivation_endpoint` – Send only `:derivation` in the instrumentation event payload (@janko)
+
+* `default_storage` – Add `Attacher.default_cache` and `Attacher.default_store` for settings (@janko)
+
+* `default_storage` – Deprecate `record` & `name` arguments to storage block (@janko)
+
+* `default_storage` – Evaluate storage block in context of `Attacher` instance (@janko)
+
+* Unify persistence plugin interface (@janko)
+
+* `upload_options` – Keep `Shrine#_upload` private (@janko)
+
+* `infer_extension` – Keep `Shrine#basic_location` private (@janko)
+
+* `model` – Add `#<name>_changed?` method to attachment module (@janko)
+
+* Make it easier for plugins to define entity and model attachment methods (@janko)
+
+* `form_assign` – Add new plugin for assigning attachment from form params without a form object (@janko)
+
+* `derivation_endpoint` – Allow passing generic IO objects to `Derivation#upload` (@janko)
+
+* `derivation_endpoint` – Accept additional uploader options in `Derivation#upload` (@janko)
+
+* `derivation_endpoint` – Close the uploaded file in `Derivation#upload` (@janko)
+
+* `core` – Stop rescuing `IO#close` exceptions in `Shrine#upload` (@janko)
+
+* `core` – Add `:delete` option to `Shrine#upload` for deleting uploaded file (@janko)
+
+* `s3` – Stop returning `:object` in `Down::ChunkedIO#data` in `S3#open` (@janko)
+
+* `s3` – Eliminate `#head_object` request in `S3#open` (@janko)
+
+* `download_endpoint` – Remove extra `Storage#exists?` check (@janko)
+
+* `derivation_endpoint` – Add `Derivation#opened` for retrieving an opened derivation result (@janko)
+
+* `derivation_endpoint` – Remove extra `Storage#exists?` check when `:upload` is enabled but not `:upload_redirect` (@janko)
+
+* `derivation_endpoint` - Don't pass source `UploadedFile` object when `:download` is `false` (@janko)
+
+* `derivation_endpoint` – Remove `:include_uploaded_file` option (@janko)
+
+* `derivation_endpoint` – Evaluate derivation block in context of `Shrine::Derivation` (@janko)
+
+* `derivation_endpoint` – Remove `:download_errors` option (@janko)
+
+* `memory` – Raise `Shrine::FileNotFound` on nonexistent file in `Memory#open` (@janko)
+
+* `file_system` – Raise `Shrine::FileNotFound` on nonexistent file in `FileSystem#open` (@janko)
+
+* `s3` – Raise `Shrine::FileNotFound` on nonexistent object in `S3#open` (@janko)
+
+* `core` – Add `Shrine::FileNotFound` exception and require storages to raise it on `Storage#open` (janko)
+
+* `instrumentation` – Remove `:metadata` from `:options` in `metadata.shrine` event (@janko)
+
+* `instrumentation` – Remove `:location`, `:upload_options` and `:metadata` from `:options` in `upload.shrine` event (@janko)
+
+* `instrumentation` – Add `:metadata` to the `upload.shrine` event (@janko)
+
+* `download_endpoint` – Drop support for legacy `/:storage/:id` URLs (@janko)
+
+* `core` – In `UploadedFile#==` require files to be of the same class (@janko)
+
+* `core` – Add `:close` option to `Shrine#upload` for preventing closing file after upload (@janko)
+
+* `memory` – Add `Shrine::Storage::Memory` from `shrine-memory` gem (@janko)
+
+* `default_url_options` – Rename to just `url_options` (@janko)
+
+* `delete_raw` – Deprecate plugin in favour of `derivatives` (@janko)
+
+* `recache` – Deprecate plugin in favour of `derivatives` (@janko)
+
+* `processing` – Deprecate plugin in favour of `derivatives` (@janko)
+
+* `versions` – Deprecate plugin in favour of `derivatives` (@janko)
+
+* `derivatives` – Add new plugin for storing processed files (@janko)
+
+* `derivation_endpoint` – Allow using symbol and string derivation names interchangeably (@janko)
+
+* `dynamic_storage` – Remove `Shrine.dynamic_storages` method (@janko)
+
+* `core` – Deep duplicate `Shrine.opts` on subclassing (@janko)
+
+* `core` – Add `Attacher#file!` which asserts that a file is attached (@janko)
+
+* `core` – Change `Shrine.uploaded_file` to raise `ArgumentError` on invalid input (@janko)
+
+* `module_include` – Deprecate plugin over overriding core classes directly (@janko)
+
+* `core` – Add `Attacher#cache_key` and `Attacher#store_key` which return storage identifiers (@janko)
+
+* `linter` – Call `Storage#open` with options as second argument (@janko)
+
+* `core` – Allow data hash passed to `UploadedFile.new` to have symbol keys (@janko)
+
+* `core` – Change how `Shrine::UploadedFile` sets its state from the given data hash (@janko)
+
+* `core` – Deprecate `Storage#open` not accepting additional options (@janko)
+
+* `refresh_metadata` – Add `Attacher#refresh_metadata!` method which integrates with `model` plugin (@janko)
+
+* `instrumentation` – Instrument any `Storage#open` calls in a new `open.shrine` event (@janko)
+
+* `restore_cached_data` – Forward options passed to `Attacher#attach_cached` to metadata extraction (@janko)
+
+* `validation` – Allow skipping validations on attaching by passing `validate: false` (@janko)
+
+* `validation` – Add `:validate` option to `Attacher#assign` or `Attacher#attach` for passing options to validation block (@janko)
+
+* `validation` – Extract validation functionality into the new plugin (@janko)
+
+* `upload_options` – Upload options from the block are now merged with passed options instead of replaced (@janko)
+
+* `upload_endpoint` – Stop passing `Rack::Request` object to the uploader (@janko)
+
+* `remote_url` – Require custom downloaders to raise `Shrine::Plugins::RemoteUrl::DownloadError` for conversion into a validation error (@janko)
+
+* `infer_extension` – Fix compatibility with the `pretty_location` plugin (@janko)
+
+* `presign_endpoint` – Remove deprecated `Shrine::Plugins::PresignEndpoint::App` constant (@janko)
+
+* `keep_files` – Remove the ability to choose whether to keep only destroyed or only replaced files (@janko)
+
+* `infer_extension` – Remove `Shrine#infer_extension` method (@janko)
+
+* `default_url_options` – Allow overriding passed URL options by deleting them inside the block (@janko)
+
+* `cached_attachment_data` – Rename `Attacher#read_cached` to `Attacher#cached_data` (@janko)
+
+* `sequel` – Add `Attacher#atomic_promote` and `Attacher#atomic_persist` (@janko)
+
+* `sequel` – Remove persistence from `Attacher#promote` (@janko)
+
+* `activerecord` – Remove persistence from `Attacher#promote` (@janko)
+
+* `atomic_helpers` – Add new plugin with helper methods for atomic promotion and persistence (@janko)
+
+* `backgrounding` – Add `Attacher#promote_block` & `Attacher#destroy_block` for overriding class level blocks (@janko)
+
+* `backgrounding` – Add `Attacher.promote_block` & `Attacher.destroy_block` on class level (@janko)
+
+* `backgrounding` – Remove overriding `Attacher#swap` with atomic promotion (@janko)
+
+* `backgrounding` – Remove `Attacher.promote`, `Attacher.delete`, `Attacher.dump`, `Attacher#dump`, `Attacher.load`, `Attacher.load_record` (@janko)
+
+* `model` – Allow disabling caching to temporary storage on assignment (@janko)
+
+* `model` – Add `Attacher.from_model`, `Attacher#write` (@janko)
+
+* `model` – Add new plugin for integrating with mutable structs (@janko)
+
+* `entity` – Add `Attacher.from_entity`, `Attacher#reload`, `Attacher#column_values`, `Attacher#attribute` (@janko)
+
+* `entity` – Add new plugin for integrating with immutable structs (@janko)
+
+* `column` – Allow changing column serializer from default `JSON` library (@janko)
+
+* `column` – Add `Attacher#column_data` and `Attacher.from_column` methods (@janko)
+
+* `column` – Add new plugin for (de)serializing attacher data (@janko)
+
+* `attachment` – Removed any default attachment methods (@janko)
+
+* `core` – Require context hash passed as second argument to `Shrine#upload` to have symbol keys (@janko)
+
+* `core` – Change `Shrine.uploaded_file` not to yield files anymore (@janko)
+
+* `core` – Allow `Shrine.uploaded_file` to accept file data hashes with symbol keys (@janko)
+
+* `core` – Remove `Shrine#uploaded?`
+
+* `core` – Remove `Shrine#delete`, `Shrine#_delete`, `Shrine#remove` (@janko)
+
+* `core` – Remove `Shrine#store`, `Shrine#_store`, `Shrine#put`, `Shrine#copy` (@janko)
+
+* `core` – Remove `Shrine#processed`, `Shrine#process` (@janko)
+
+* `core` – Don't pass `:phase` anymore on uploads (@janko)
+
+* `core` – Read attachment from the record attribute only on initialization (@janko)
+
+* `core` – Don't require a temporary storage (@janko)
+
+* `core` – Add `Attacher#data` and `Attacher.from_data` for dumping to and loading from a Hash (@janko)
+
+* `core` – Change `Attacher#assign` to raise exception when non-cached file is assigned (@janko)
+
+* `core` – Enable `Attacher#assign` to accept cached file data as a Hash (@janko)
+
+* `core` – Add `Attacher#file` alias for `Attacher#get` (@janko)
+
+* `core` – Change `Attacher#attached?` to return whether a file is attached (@janko)
+
+* `core` – Change `Attacher#promote` to always only save promoted file in memory (@janko)
+
+* `core` – Rename `Attacher#replace` to `Attacher#destroy_previous` (@janko)
+
+* `core` – Remove `Attacher#_promote` and `Attacher#_delete`, add `Attacher#promote_cached` and `Attacher#destroy_attached` (@janko)
+
+* `core` – Rename `Attacher#set` and `Attacher#_set` to `Attacher#change` and `Attacher#set` (@janko)
+
+* `core` – Remove `Attacher#cache!` and `Attacher#store!`, add `Attacher#upload` (@janko)
+
+* `core` – Rename `Attacher#validate_block` to `Attacher#_validate` (@janko)
+
+* `core` – Add `Attacher#attach`, `Attacher#attach_cached`, extracted from `Attacher#assign` (@janko)
+
+* `core` – Remove `Attacher#swap`, `Attacher#update`, `Attacher#read`, `Attacher#write`, `Attacher#data_attribute`, `Attacher#convert_to_data`, `Attacher#convert_before_write`, and `Attacher#convert_after_read` (@janko)
+
+* `core` – Change `Attacher.new` to not accept a model anymore (@janko)
+
+* `delete_promoted` – Remove plugin (@janko)
+
+* `parsed_json` – Remove plugin (@janko)
+
+* `parallelize` – Remove plugin (@janko)
+
+* `hooks` – Remove plugin (@janko)
+
+* `core` – Remove deprecated `Shrine::IO_METHODS` constant (@janko)
+
+* `s3` – Replace source object metadata when copying a file from S3 (@janko)
+
+* `core` – Change `UploadedFile#storage_key` to return a Symbol instead of a String (@janko)
+
+* `infer_extension` – Make `:mini_mime` the default analyzer (@janko)
+
+* Bring back Ruby 2.3 support (@janko)
+
+* `versions` – Remove deprecated `:version_names`, `Shrine.version_names` and `Shrine.version?` (@janko)
+
+* `validation_helpers` – Remove support for regexes in MIME type or extension validations (@janko)
+
+* `validation_helpers` – Don't require `#width` and `#height` methods to be defined on `UploadedFile` (@janko)
+
+* `validation_helpers` – Fail dimensions validations when `width` or `height` metadata is missing (@janko)
+
+* `upload_endpoint` – Remove deprecated `Shrine::Plugins::UploadEndpoint::App` constant (@janko)
+
+* `determine_mime_type` – Remove `Shrine#mime_type_analyzers` method (@janko)
+
+* `store_dimensions` – Remove `Shrine#extract_dimensions` and `Shrine#dimensions_analyzers` methods (@janko)
+
+* `rack_file` – Remove deprecated `Shrine::Plugins::RackFile::UploadedFile` constant (@janko)
+
+* `rack_file` – Drop support for passing file hash to `Shrine#upload` and `Shrine#store` (@janko)
+
+* `download_endpoint` – Move `Shrine::Plugins::DownloadEndpoint::App` into `Shrine::DownloadEndpoint` (@janko)
+
+* `download_endpoint` – Remove deprecated `Shrine::DownloadEndpoint` constant (@janko)
+
+* `download_endpoint` – Remove deprecated `:storages` option (@janko)
+
+* `determine_mime_type` – Remove deprecated `:default` analyzer alias (@janko)
+
+* `default_url` – Remove deprecated block argument when loading the plugin (@janko)
+
+* `data_uri` – Remove deprecated `Shrine::Plugins::DataUri::DataFile` constant (@janko)
+
+* `data_uri` – Remove deprecated `:filename` plugin option (@janko)
+
+* `cached_attachment_data` – Remove deprecated model setter (@janko)
+
+* `file_system` – Remove deprecated `:older_than` option in `FileSystem#clear!` (@janko)
+
+* `file_system` – Don't accept a block anymore in `FileSystem#open` (@janko)
+
+* `file_system` – Remove deprecated `FileSystem#download` method (@janko)
+
+* `file_system` – Make `FileSystem#movable?` and `FileSystem#move` methods private (@janko)
+
+* `file_system` – Remove deprecation warning on unrecognized options in `FileSystem#upload` (@janko)
+
+* `file_system` – Remove deprecated `:host` option for `FileSystem#initialize` (@janko)
+
+* `moving` – Remove deprecated plugin (@janko)
+
+* `multi_delete` – Remove deprecated plugin (@janko)
+
+* `direct_upload` – Remove deprecated plugin (@janko)
+
+* `backup` – Remove deprecated plugin (@janko)
+
+* `background_helpers` – Remove deprecated plugin (@janko)
+
+* `migration_helpers` – Remove deprecated plugin (@janko)
+
+* `copy` – Remove deprecated plugin (@janko)
+
+* `logging` – Remove deprecated plugin (@janko)
+
+* `s3` – Remove deprecated `S3#download` method (@janko)
+
+* `s3` – Remove deprecated `S3#stream` method (@janko)
+
+* `presign_endpoint` – Drop support for presign objects that don't respond to `#to_h` (@janko)
+
+* `s3` – Return a Hash in `S3#presign` when method is POST (@janko)
+
+* `s3` – Remove `:download` option in `S3#url` (@janko)
+
+* `s3` – Remove support for non URI-escaped content disposition values (@janko)
+
+* `s3` – Remove `S3#s3` method (@janko)
+
+* `s3` – Remove support for specifying `:multipart_threshold` as an integer (@janko)
+
+* `s3` – Remove `:host` option on `S3#initialize` (@janko)
+
+* `s3` – Drop support for `aws-sdk-s3` versions lower than 1.14 (@janko)
+
+* `s3` – Drop support for `aws-sdk` 2.x (@janko)
+
+## 2.19.0 (2019-07-18) [[release notes]](https://shrinerb.com/docs/release_notes/2.19.0)
 
 * `pretty_location` – Allow specifying a different identifier from `id` (@00dav00)
 
@@ -72,7 +554,7 @@
 
 * `core` – Allow registering storage objects under string keys (@janko)
 
-## 2.18.0 (2019-06-24)
+## 2.18.0 (2019-06-24) [[release notes]](https://shrinerb.com/docs/release_notes/2.18.0)
 
 * `core` – Add `Shrine.upload` method as a shorthand for `Shrine.new(...).upload(...)` (@janko)
 
@@ -96,7 +578,7 @@
 
 * `parsed_json` – Fix overriden `Attacher#assign` not accepting second argument (@janko)
 
-## 2.17.0 (2019-05-06)
+## 2.17.0 (2019-05-06) [[release notes]](https://shrinerb.com/docs/release_notes/2.17.0)
 
 * `data_uri` – Add `Attacher#assign_data_uri` which accepts additional `Shrine#upload` options (@janko)
 
@@ -146,7 +628,7 @@
 
 * `parsed_json` – Accepts hashes with symbols keys (@aglushkov)
 
-## 2.16.0 (2019-02-18)
+## 2.16.0 (2019-02-18) [[release notes]](https://shrinerb.com/docs/release_notes/2.16.0)
 
 * `derivation_endpoint` – Add `:upload_open_options` for download option for derivation result (@janko)
 
@@ -172,7 +654,7 @@
 
 * Fix `store_dimensions` plugin making second argument in `Shrine#extract_metadata` mandatory (@jrochkind)
 
-## 2.15.0 (2019-02-08)
+## 2.15.0 (2019-02-08) [[release notes]](https://shrinerb.com/docs/release_notes/2.15.0)
 
 * Add `derivation_endpoint` plugin for processing uploaded files on-the-fly (@janko)
 
@@ -182,7 +664,7 @@
 
 * Yield a new File object on `Shrine.with_file` when `tempfile` plugin is loaded (@janko)
 
-## 2.14.0 (2018-12-27)
+## 2.14.0 (2018-12-27) [[release notes]](https://shrinerb.com/docs/release_notes/2.14.0)
 
 * Add `tempfile` plugin for easier reusing of the same uploaded file copy on disk (@janko)
 
@@ -252,7 +734,7 @@
 
 * Use a guard raise cause for `bucket` argument in S3 for an appropriate error message (@ardecvz)
 
-## 2.13.0 (2018-11-04)
+## 2.13.0 (2018-11-04) [[release notes]](https://shrinerb.com/docs/release_notes/2.13.0)
 
 * Specify UTF-8 charset in `Content-Type` response header in `presign_endpoint` plugin (@janko)
 
@@ -284,7 +766,7 @@
 
 * In `S3#upload` deprecate using aws-sdk-s3 lower than 1.14 when uploading IO objects of unknown size (@janko)
 
-## 2.12.0 (2018-08-22)
+## 2.12.0 (2018-08-22) [[release notes]](https://shrinerb.com/docs/release_notes/2.12.0)
 
 * Ignore nil values when assigning files from a remote URL (@janko)
 
@@ -312,7 +794,7 @@
 
 * Make `UploadedFile#open` always open a new IO object and close the previous one (@janko)
 
-## 2.11.0 (2018-04-28)
+## 2.11.0 (2018-04-28) [[release notes]](https://shrinerb.com/docs/release_notes/2.11.0)
 
 * Add `Shrine.with_file` for temporarily converting an IO-like object into a file (@janko)
 
@@ -340,7 +822,7 @@
 
 * Deprecate `direct_upload` plugin in favor of `upload_endpoint` and `presign_endpoint` plugins (@janko)
 
-## 2.10.0 (2018-03-28)
+## 2.10.0 (2018-03-28) [[release notes]](https://shrinerb.com/docs/release_notes/2.10.0)
 
 * Add `:fastimage` analyzer to `determine_mime_type` plugin (@mokolabs)
 
@@ -362,7 +844,7 @@
 
 * Inherit the logger on subclassing `Shrine` and make it shared across subclasses (@hmistry)
 
-## 2.9.0 (2018-01-27)
+## 2.9.0 (2018-01-27) [[release notes]](https://shrinerb.com/docs/release_notes/2.9.0)
 
 * Support arrays of files in `versions` plugin (@janko)
 
@@ -386,7 +868,7 @@
 
 * Allow passing options to `Model#<attachment>_attacher` for overriding `Attacher` options (@janko)
 
-## 2.8.0 (2017-10-11)
+## 2.8.0 (2017-10-11) [[release notes]](https://shrinerb.com/docs/release_notes/2.8.0)
 
 * Expand relative directory paths when initializing `Storage::FileSystem` (@janko)
 
@@ -416,7 +898,7 @@
 
 * Update `direct_upload` plugin to support Roda 3 (@janko)
 
-## 2.7.0 (2017-09-11)
+## 2.7.0 (2017-09-11) [[release notes]](https://shrinerb.com/docs/release_notes/2.7.0)
 
 * Deprecate the `Shrine::DownloadEndpoint` constant over `Shrine.download_endpoint` (@janko)
 
@@ -484,11 +966,11 @@
 
 * Don't add a newline at the end of the base64-formatted signature (@janko)
 
-## 2.6.1 (2017-04-12)
+## 2.6.1 (2017-04-12) [[release notes]](https://shrinerb.com/docs/release_notes/2.6.1)
 
 * Fix `download_endpoint` returning incorrect reponse body in some cases (@janko)
 
-## 2.6.0 (2017-04-04)
+## 2.6.0 (2017-04-04) [[release notes]](https://shrinerb.com/docs/release_notes/2.6.0)
 
 * Make `Shrine::Storage::FileSystem#path` public which returns path to the file as a `Pathname` object (@janko)
 
@@ -560,7 +1042,7 @@
 
 * Raise `Shrine::Error` when `Shrine#generate_location` returns nil (@janko)
 
-## 2.5.0 (2016-11-11)
+## 2.5.0 (2016-11-11) [[release notes]](https://shrinerb.com/docs/release_notes/2.5.0)
 
 * Add `Attacher.default_url` as the idiomatic way of declaring default URLs (@janko)
 
@@ -586,7 +1068,7 @@
 
 * Make it possible to extract multiple metadata values at once with the `add_metadata` plugin (@janko)
 
-## 2.4.1 (2016-10-17)
+## 2.4.1 (2016-10-17) [[release notes]](https://shrinerb.com/docs/release_notes/2.4.1)
 
 * Move back JSON serialization from `Attacher#write` to `Attacher#_set` (@janko)
 
@@ -596,7 +1078,7 @@
 
 * In `UploadedFile#download` use extension from `#original_filename` if `#id` doesn't have it (@janko)
 
-## 2.4.0 (2016-10-11)
+## 2.4.0 (2016-10-11) [[release notes]](https://shrinerb.com/docs/release_notes/2.4.0)
 
 * Add `#convert_before_write` and `#convert_after_read` on the Attacher for data attribute conversion (@janko)
 
@@ -632,11 +1114,11 @@
 
 * Override `#to_s` in `Shrine::Attachment` for better introspection with `puts` (@janko)
 
-## 2.3.1 (2016-09-01)
+## 2.3.1 (2016-09-01) [[release notes]](https://shrinerb.com/docs/release_notes/2.3.1)
 
 * Don't change permissions of existing directories in FileSystem storage (@janko)
 
-## 2.3.0 (2016-08-27)
+## 2.3.0 (2016-08-27) [[release notes]](https://shrinerb.com/docs/release_notes/2.3.0)
 
 * Prevent client from caching the presign response in direct_upload plugin (@janko)
 
@@ -662,7 +1144,7 @@
 
 * Add `:directory_permissions` to `Storage::FileSystem` (@janko)
 
-## 2.2.0 (2016-07-29)
+## 2.2.0 (2016-07-29) [[release notes]](https://shrinerb.com/docs/release_notes/2.2.0)
 
 * Soft deprecate `:phase` over `:action` in `context` (@janko)
 
@@ -694,11 +1176,11 @@
 
 * Avoid an additional HEAD request to determine content length in multipart S3 copy (@janko)
 
-## 2.1.1 (2016-07-14)
+## 2.1.1 (2016-07-14) [[release notes]](https://shrinerb.com/docs/release_notes/2.1.1)
 
 * Fix `S3#open` throwing a NameError if `net/http` isn't required (@janko)
 
-## 2.1.0 (2016-06-27)
+## 2.1.0 (2016-06-27) [[release notes]](https://shrinerb.com/docs/release_notes/2.1.0)
 
 * Remove `:names` from versions plugin, and deprecate generating versions in :cache phase (@janko)
 
@@ -714,11 +1196,11 @@
 
 * Deprecate `#cached_<attachment>_data=` over using `<attachment>` for the hidden field (@janko)
 
-## 2.0.1 (2016-05-30)
+## 2.0.1 (2016-05-30) [[release notes]](https://shrinerb.com/docs/release_notes/2.0.1)
 
 * Don't override previously set default_url in versions plugin (@janko)
 
-## 2.0.0 (2016-05-19)
+## 2.0.0 (2016-05-19) [[release notes]](https://shrinerb.com/docs/release_notes/2.0.0)
 
 * Include query parameters in CDN-ed S3 URLs, making them work for private objects (@janko)
 
@@ -798,17 +1280,17 @@
 
 * Deprecate loading the backgrounding plugin through the old "background_helpers" alias (@janko)
 
-## 1.4.2 (2016-04-19)
+## 1.4.2 (2016-04-19) [[release notes]](https://shrinerb.com/docs/release_notes/1.4.2)
 
 * Removed ActiveRecord's automatic support for optimistic locking as it wasn't stable (@janko)
 
 * Fixed record's dataset being modified after promoting preventing further updates with the same instance (@janko)
 
-## 1.4.1 (2016-04-18)
+## 1.4.1 (2016-04-18) [[release notes]](https://shrinerb.com/docs/release_notes/1.4.1)
 
 * Bring back triggering callbacks on promote in ORM plugins, and add support for optimistic locking (@janko)
 
-## 1.4.0 (2016-04-15)
+## 1.4.0 (2016-04-15) [[release notes]](https://shrinerb.com/docs/release_notes/1.4.0)
 
 * Return "Content-Length" response header in download_endpoint plugin (@janko)
 
@@ -864,7 +1346,7 @@
 
 * Fix keep_files not to spawn a background job when file will not be deleted (@janko)
 
-## 1.3.0 (2016-03-12)
+## 1.3.0 (2016-03-12) [[release notes]](https://shrinerb.com/docs/release_notes/1.3.0)
 
 * Add `<attachment>_cached?` and `<attachment>_stored?` to migration_helpers plugin (@janko)
 
@@ -906,7 +1388,7 @@
 
 * Fix `NameError` when silencing "missing record" errors in backgrounding (@janko)
 
-## 1.2.0 (2016-01-26)
+## 1.2.0 (2016-01-26) [[release notes]](https://shrinerb.com/docs/release_notes/1.2.0)
 
 * Make `Shrine::Attacher.promote` and `Shrine::Attacher.delete` return the record in backgrounding plugin (@janko)
 
@@ -922,7 +1404,7 @@
 
 * Make custom metadata inherited from uploaded files and make `#extract_metadata` called only on caching (@janko)
 
-## 1.1.0 (2015-12-26)
+## 1.1.0 (2015-12-26) [[release notes]](https://shrinerb.com/docs/release_notes/1.1.0)
 
 * Rename the "background_helpers" plugin to "backgrounding" (@janko)
 
@@ -992,7 +1474,7 @@
 
 * Reduce length of URLs generated with pretty_location plugin (@gshaw)
 
-## 1.0.0 (2015-11-27)
+## 1.0.0 (2015-11-27) [[release notes]](https://shrinerb.com/docs/release_notes/1.0.0)
 
 * Improve Windows compatibility in the FileSystem storage (@janko)