diff options
author | Karen Tracey <kmtracey@gmail.com> | 2022-09-30 10:59:06 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-09-30 16:59:06 +0200 |
commit | 21d83b3218872a6256df265904483b050dcba32d (patch) | |
tree | 6d6365a3e8bfb0b551c5fd6e60cca9a212073f80 | |
parent | 99a4145bbf41b0d1192319a84b83c9a609621cf8 (diff) | |
download | django-compressor-21d83b3218872a6256df265904483b050dcba32d.tar.gz |
Update doc in light of new mangled name avoidance (#1145)
* Update doc in light of new mangled name avoidance
https://github.com/django-compressor/django-compressor/pull/1107 moved file-name-mangling avoidance into a `save` override, but the doc suggests calling `_save` which bypassess the new file-name-mangling-avoidance code. Updating a project to use django-compressor 4.0 that had a storages class which followed this doc resulted in mangled-named files appearing in the file system (and ultimately css changes not getting built/deployed, since the changes were in the mangled-name files while the rest of the process was using the "bare" name).
* Update changelog.txt
-rw-r--r-- | docs/changelog.txt | 11 | ||||
-rw-r--r-- | docs/remote-storages.txt | 2 |
2 files changed, 12 insertions, 1 deletions
diff --git a/docs/changelog.txt b/docs/changelog.txt index b8415f0..55aaceb 100644 --- a/docs/changelog.txt +++ b/docs/changelog.txt @@ -4,6 +4,11 @@ Changelog Unreleased ---------- +- Update the `CachedS3Boto3Storage` example storage subclass in "Remote Storages" + to work properly after the v4.0 change to how duplicate file names are handled + by `CompressorFileStorage` + + v4.1 (2022-08-03) ----------------- @@ -25,6 +30,12 @@ v4.0 (2022-03-23) - Fix intermittent No such file or directory errors by changing strategy to deal with duplicate filenames in CompressorFileStorage + + Note: if your project has a custom storage backend following the example of + `CachedS3Boto3Storage` from the "Remote Storages" documentation, it will need + to be updated to call `save` instead of `_save` to work properly after this + change to `CompressorFileStorage`. + - Deprecate SlimItFilter, stop testing it with Python 3.7 or higher diff --git a/docs/remote-storages.txt b/docs/remote-storages.txt index 8342bd3..1a8fd44 100644 --- a/docs/remote-storages.txt +++ b/docs/remote-storages.txt @@ -66,7 +66,7 @@ apps can be integrated. "compressor.storage.CompressorFileStorage")() def save(self, name, content): - self.local_storage._save(name, content) + self.local_storage.save(name, content) super().save(name, self.local_storage._open(name)) return name |