Merge pull request #35 from tattersoftware/release

Release Docs

Author: MGatner

README.md

@@ -2,9 +2,10 @@
 
 Asset handling for CodeIgniter 4
 
-[![](https://github.com/tattersoftware/codeigniter4-assets/workflows/PHPUnit/badge.svg)](https://github.com/tattersoftware/codeigniter4-assets/actions?query=workflow%3A%22PHPUnit)
-[![](https://github.com/tattersoftware/codeigniter4-assets/workflows/PHPStan/badge.svg)](https://github.com/tattersoftware/codeigniter4-assets/actions?query=workflow%3A%22PHPStan)
-[![Coverage Status](https://coveralls.io/repos/github/tattersoftware/codeigniter4-assets/badge.svg?branch=develop)](https://coveralls.io/github/tattersoftware/codeigniter4-assets?branch=develop)
+[![](https://github.com/tattersoftware/codeigniter4-assets/workflows/PHPUnit/badge.svg)](https://github.com/tattersoftware/codeigniter4-assets/actions/workflows/test.yml)
+[![](https://github.com/tattersoftware/codeigniter4-assets/workflows/PHPStan/badge.svg)](https://github.com/tattersoftware/codeigniter4-assets/actions/workflows/analyze.yml)
+[![](https://github.com/tattersoftware/codeigniter4-assets/workflows/Deptrac/badge.svg)](https://github.com/tattersoftware/codeigniter4-assets/actions/workflows/inspect.yml)
+[![Coverage Status](https://coveralls.io/repos/github/tattersoftware/codeigniter4-assets/badge.svg?branch=develop)](https://coveralls.io/github/organization/name?branch=develop)
 
 ## Quick Start
 

UPGRADING.md

@@ -0,0 +1,17 @@
+# Upgrade Guide
+
+## Version 2 to 3
+***
+
+> Note: This is a complete refactor! Please be sure to read the docs carefully before upgrading.
+
+* The services no longer exist; remove all references to `Services::Assets` and `Services::manifests` to avoid exceptions
+* This library no longer publishes Assets; convert Manifests to the framework's new [Publisher format](https://codeigniter.com/user_guide/libraries/publisher.html)
+* Many of the example Manifests now have an official Publisher equivalent at [Tatter\Frontend](https://github.com/tattersoftware/codeigniter4-frontend)
+* The `DirectoryHandler` (mapping public directories to routes) has no equivalent in `v3` so be sure to create explicit bundles and routes for any you were using
+* The view files have been removed and replaced by `AssetsFilter` to handle tag injection directly; read the docs on setting up the filter
+
+For an example of converting a `v2` JSON manifest to a `v3` framework Publisher compare these files:
+
+* https://github.com/tattersoftware/codeigniter4-assets/blob/267220d437786e0ddb9d7681745f5942d95c543b/manifests/FontAwesome.json
+* https://github.com/tattersoftware/codeigniter4-frontend/blob/ae61773f279333c3a606498364977a8cec45d303/src/Publishers/FontAwesomePublisher.php

src/RouteBundle.php

@@ -56,7 +56,8 @@ public static function createFromRoute(string $uri): self
             }
         }
 
-        if (isset($key)) {
+        // Re-check the config in case one of the included items requested cache exemption
+        if ($config->useCache && isset($key)) {
             cache()->save($key, $bundle);
         }