UHF-11009: Add documentation

City-of-Helsinki · Jan 14, 2025 · 98b8a3f · 98b8a3f
1 parent 421f59f
commit 98b8a3f
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -29,6 +29,7 @@ A base module for [drupal-helfi-platform](https://github.com/City-of-Helsinki/dr
 - [Remote Entity](documentation/remote-entity.md): A base entity to be used with migrations.
 - [Testing](documentation/testing.md): Various features to help with automated testing.
 - [User expire](/documentation/user-expire.md): Block inactive accounts automatically.
+- [Asset versioning](./documentation/asset-versioning.md): Replace js/css library version with deployment identifier.
 
 ## Contact
 

diff --git a/documentation/asset-versioning.md b/documentation/asset-versioning.md
@@ -0,0 +1,17 @@
+## Asset versioning
+
+Helfi api base replaces `HELFI_DEPLOYMENT_IDENTIFIER` in libraries.yml files with `filemtime()` of composer.lock file. This can be used in theme or module libraries.yml files to automatically bust caches when dependencies are updated.
+
+Example:
+```
+my-library:
+  version: HELFI_DEPLOYMENT_IDENTIFIER
+  js:
+    dist/js/my-library.min.js: {
+      preprocess: false,
+      minified: true
+    }
+  dependencies:
+    - core/drupalSettings
+    - core/drupal
+```