From ad4bddbd0187a6af076e92a64bb4e91dd7bfdda6 Mon Sep 17 00:00:00 2001 From: Colin O'Dell Date: Sat, 2 Jul 2016 14:45:45 -0400 Subject: [PATCH] Prepare to release 0.14.0 --- CHANGELOG.md | 7 ++++++- README.md | 2 +- UPGRADE.md | 19 +++++++++++++++++++ composer.json | 2 +- 4 files changed, 27 insertions(+), 3 deletions(-) create mode 100644 UPGRADE.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 2093483fa8..f1fc2176a4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,11 +4,15 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip ## [Unreleased][unreleased] +## [0.14.0] - 2016-07-02 ### Added - The `safe` option is deprecated and replaced by 2 new options (#253, #255): - `html_input` (`strip`, `allow` or `escape`): how to handle untrusted HTML input (the default is `strip` for BC reasons) - `allow_unsafe_links` (`true` or `false`): whether to allow risky image URLs and links (the default is `true` for BC reasons) +### Deprecated + - The `safe` option is now deprecated and will be removed in the 1.0.0 release. + ## [0.13.4] - 2016-06-14 ### Fixed @@ -417,7 +421,8 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip ### Added - Initial commit (compatible with jgm/stmd:spec.txt @ 0275f34) -[unreleased]: https://github.com/thephpleague/commonmark/compare/0.13.4...HEAD +[unreleased]: https://github.com/thephpleague/commonmark/compare/0.14.0...HEAD +[0.14.0]: https://github.com/thephpleague/commonmark/compare/0.13.4...0.14.0 [0.13.4]: https://github.com/thephpleague/commonmark/compare/0.13.3...0.13.4 [0.13.3]: https://github.com/thephpleague/commonmark/compare/0.13.2...0.13.3 [0.13.2]: https://github.com/thephpleague/commonmark/compare/0.13.1...0.13.2 diff --git a/README.md b/README.md index b30432ffcb..cb86ec4265 100644 --- a/README.md +++ b/README.md @@ -136,7 +136,7 @@ The following table shows which versions of league/commonmark are compatible wit - 0.13.4
0.13.3
0.13.2 + 0.14.0
0.13.4
0.13.3
0.13.2 0.25 diff --git a/UPGRADE.md b/UPGRADE.md new file mode 100644 index 0000000000..a8a52eefec --- /dev/null +++ b/UPGRADE.md @@ -0,0 +1,19 @@ +# Upgrade Instructions + +## 0.14.0 + +### `safe` option deprecated + +The `safe` option has been deprecated and replaced with two new configuration options: + +* `html_input` - How to handle HTML input. Set this option to one of the following values: + - `strip` - Strip all HTML (equivalent to `'safe' => true`) + - `allow` - Allow all HTML input as-is (equivalent to `'safe' => false) + - `escape` - Escape all HTML + +* `allow_unsafe_links` - Whether to allow risky image URLs and links + - `true` - Allow (equivalent to `'safe' => false`) + - `false` - Remove all risky URLs (equivalent to `'safe' => true`) + +Although `safe` will continue to work until 1.0.0 you should consider updating your configuration now if possible. + diff --git a/composer.json b/composer.json index cb0262f672..6c05f3c092 100644 --- a/composer.json +++ b/composer.json @@ -60,7 +60,7 @@ "bin": ["bin/commonmark"], "extra": { "branch-alias": { - "dev-master": "0.14-dev" + "dev-master": "0.15-dev" } } }