Added "How to Use a Custom Version Strategy for Assets" #7141
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
you should also fix conflicts |
6bc5efb to
c59cff6
Compare
OskarStark
reviewed
Nov 15, 2016
| :ref:`version <reference-framework-assets-version>` and | ||
| :ref:`version_format <reference-framework-assets-version-format>` configuration | ||
| options. If your application requires a more advanced versioning, you can create | ||
| your own version strategy. |
There was a problem hiding this comment.
Shouldn't we add an example here, what "requires a more advanced versioning" means?
There was a problem hiding this comment.
I've reworded this part a bit. Thanks.
| Asset version strategies are PHP classes that implement the | ||
| :class:`Symfony\\Component\\Asset\\VersionStrategy\\VersionStrategyInterface`. | ||
| In this example, the constructor of the class takes as arguments the path to | ||
| the manifest file generated by gulp-buster and the format of the generated |
There was a problem hiding this comment.
gulp buster should be a link here, too
| @@ -93,6 +93,8 @@ Returns an instance of ``ControllerReference`` to be used with functions | ||
| like :ref:`render() <reference-twig-function-render>` and | ||
| :ref:`render_esi() <reference-twig-function-render-esi>`. | ||
|
|
||
| .. _reference-twig-function-asset: |
There was a problem hiding this comment.
why did you add this here @javiereguiluz ?
There was a problem hiding this comment.
Good catch. It was in the original PR. I've just removed it.
xabbuh
reviewed
Dec 8, 2016
|
|
||
| Finally, enable the new asset versioning for all the application assets or just | ||
| for some :ref:`asset package <reference-framework-assets-packages>` thanks to | ||
| the :ref:`version_strategy <reference-framework-assets-version_strategy>` option: |
There was a problem hiding this comment.
It looks like you have to add a label for this.
xabbuh
requested changes
Dec 9, 2016
| Asset versioning is a technique that improves the performance of web | ||
| applications by adding a version identifier to the URL of the static assets | ||
| (CSS, JavaScript, images, etc.) When the content of the asset changes, its | ||
| identifier is also modified to force the browser download it again instead of |
There was a problem hiding this comment.
[...] the browser to download it [...]
|
|
||
| private function loadManifest(array $options) | ||
| { | ||
| $hashes = json_decode(file_get_contents($this->manifestPath), true); |
| Register the Strategy Service | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| After creating the strategy PHP class, register it as a Symfony service |
There was a problem hiding this comment.
Missing colon at the end of the sentence.
| http://symfony.com/schema/dic/symfony http://symfony.com/schema/dic/symfony/symfony-1.0.xsd"> | ||
|
|
||
| <framework:config> | ||
| <framework:assets version_strategy="app.assets.versioning.gulp_buster" /> |
There was a problem hiding this comment.
In XML, the attribute should be version-strategy.
|
|
||
| **type**: ``string`` **default**: null | ||
|
|
||
| The service id of the :doc:`asset version strategy </frontend/custom_version:strategy>` |
There was a problem hiding this comment.
The colon in the path would be an underscore.
|
@xabbuh thanks for your review. I've fixed everything. |
xabbuh
reviewed
Dec 9, 2016
| @@ -1013,6 +1016,7 @@ Each package can configure the following options: | ||
| * :ref:`base_urls <reference-assets-base-urls>` | ||
| * :ref:`version <reference-framework-assets-version>` | ||
| * :ref:`version_format <reference-assets-version-format>` | ||
| * :ref:`version_strategy <reference-assets-version-strategy>` |
There was a problem hiding this comment.
I guess this should be reference-framework-assets-version_strategy instead (see the build failure on Travis CI).
|
👍 Status: Reviewed |
xabbuh
approved these changes
Dec 9, 2016
|
Thank you Javier. |
xabbuh
added a commit
that referenced
this pull request
Dec 12, 2016
…teohhanhui, javiereguiluz) This PR was merged into the 2.7 branch. Discussion ---------- Added "How to Use a Custom Version Strategy for Assets" This PR finishes the great work made by @teohhanhui in #5489. Commits ------- 1399967 Fixed a label name 981e82d Misc fixes a02f3b3 Added the version_strategy option to the config reference 2830ba0 Added the missing doc label 482fda5 Minor rewords and fixes f038483 Removed an unneeded change ab8fa54 Fixed a rebase error c59cff6 Moved the article to its new location 5971ce0 Removed an unneeded file 40dff64 Minor updates to the doc and service config 80d0ca2 Simplified the intro 4f530d8 Cookbook entry: Asset - Custom Version Strategy
|
And thank you for starting this awesome PR @teohhanhui! |
xabbuh
added a commit
that referenced
this pull request
Dec 13, 2016
This PR was merged into the 2.7 branch. Discussion ---------- Revert the merge of #7141 I shouldn't have merged #7141 into the `2.7` branch as the related code PR (symfony/symfony#17532) was released with Symfony 3.1. Commits ------- 0f7c7d5 Revert "minor #7141 Added "How to Use a Custom Version Strategy for Assets" (teohhanhui, javiereguiluz)"
xabbuh
added a commit
that referenced
this pull request
Dec 13, 2016
* 2.7: Revert "minor #7141 Added "How to Use a Custom Version Strategy for Assets" (teohhanhui, javiereguiluz)"
xabbuh
added a commit
that referenced
this pull request
Dec 13, 2016
* 2.8: Revert "minor #7141 Added "How to Use a Custom Version Strategy for Assets" (teohhanhui, javiereguiluz)"
xabbuh
added a commit
that referenced
this pull request
Dec 13, 2016
* 3.1: Revert "minor #7141 Added "How to Use a Custom Version Strategy for Assets" (teohhanhui, javiereguiluz)"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR finishes the great work made by @teohhanhui in #5489.