diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..0269a867 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,64 @@ +# django-webpack-loader changelog + +For more general information, view the [readme](README.md). + +Releases are added to the +[github release page](https://github.com/ezhome/django-webpack-loader/releases). + +## [0.5.0] -- 2017-05-20 + +- Added ability to access the webpack asset path information from application +- Fixed potential crash when formatting errors +- Added django 1.11 to test suite + +## [0.4.0] -- 2016-10-26 + +- Added ability to compile webpack to gzip bundles +- Added poll interval option (time to wait between polling the stats file) +- Added timeout (maximum wait-time before throwing an Exception) +- Added django 1.10 to test suite + +## [0.3.3] -- 2016-07-24 + +- Added Makefile for easier development +- Added ability timeout when waiting for webpack to compile a bundle + +## [0.3.2] -- 2016-07-24 + +- Added ability to add attrs to render_bundle tag + +## [0.3.1] -- 2016-07-24 + +- documented webpack_static tag + +## [0.3.0] -- 2015-02-21 + +- breaking 💥: new CACHE setting which when set to true makes the loader cache the contents of the stats files in memory. If set to True, server will restart every time the stats file contents change or it'll keep serving old, cached URLs. CACHE defaults to not DEBUG by default. +- Fixed Exception +- Added django 1.9 to test suite + +## [0.2.4] -- 2015-12-23 + +- Fix unicode errors + +## [0.2.3] -- 2015-12-03 + +- mark safe template tags + +## [0.2.2] -- 2015-09-21 + +- fix webpack exceptions + +## [0.2.1] -- 2015-12-03 + +- add custom exception for WebpackLoaderBadStatsError + +## [0.2.0] -- 2015-09-10 + +- breaking 💥: revised django settings configuration syntax +- webpack loader can now consume the output of multiple stats files in the same project +- add ``get_files`` template tag + +## [0.1.2] -- 2015-05-25 + +- first documented release diff --git a/README.md b/README.md index 26f6133d..46e64940 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,13 @@ Use webpack to generate your static bundles without django's staticfiles or opaq Django webpack loader consumes the output generated by [webpack-bundle-tracker](https://github.com/owais/webpack-bundle-tracker) and lets you use the generated bundles in django. +A [changelog](CHANGELOG.md) is also available. + ## Maintainers In order to overcome the lack of support for Markdown on PyPi, building this package can use [pandoc](http://pandoc.org/installing.html) along with [pypandoc](https://pypi.python.org/pypi/pypandoc) to convert the README.md into a Restructured Text format compatible with PyPI. This requires installing `pandoc` for your operating system (installation instructions on the pandoc site), and `pypandoc` which will be installed if you: pip install -r requirements-dev.txt - + before uploading to PyPI. If pandoc or pypandoc fails, the README.md file will be uploaded as it was before this enhancement. @@ -168,7 +170,7 @@ and your webpack config is located at `/home/src/webpack.config.js`, then the va #### TIMEOUT -`TIMEOUT` is the number of seconds webpack_loader should wait for webpack to finish compiling before raising an exception. `0`, `None` or leaving the value out of settings disables timeouts. +`TIMEOUT` is the number of seconds webpack_loader should wait for webpack to finish compiling before raising an exception. `0`, `None` or leaving the value out of settings disables timeouts.
@@ -310,7 +312,7 @@ the function in the `webpack_loader.utils` module. ['', ''] ``` - + ## How to use in Production **It is up to you**. There are a few ways to handle this. I like to have slightly separate configs for production and local. I tell git to ignore my local stats + bundle file but track the ones for production. Before pushing out newer version to production, I generate a new bundle using production config and commit the new stats file and bundle. I store the stats file and bundles in a directory that is added to the `STATICFILES_DIR`. This gives me integration with collectstatic for free. The generated bundles are automatically collected to the target directory and synched to S3.