Skip to content

Commit

Permalink
Prepare to release 0.14.0
Browse files Browse the repository at this point in the history
  • Loading branch information
colinodell committed Jul 2, 2016
1 parent 1675311 commit ad4bddb
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 3 deletions.
7 changes: 6 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ The following table shows which versions of league/commonmark are compatible wit
</thead>
<tbody>
<tr>
<td><strong>0.13.4</strong><br>0.13.3<br>0.13.2</td>
<td><strong>0.14.0</strong><br>0.13.4<br>0.13.3<br>0.13.2</td>
<td><strong><a href="http://spec.commonmark.org/0.25/">0.25</a></strong></td>
</tr>
<tr>
Expand Down
19 changes: 19 additions & 0 deletions UPGRADE.md
Original file line number Diff line number Diff line change
@@ -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.

2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
"bin": ["bin/commonmark"],
"extra": {
"branch-alias": {
"dev-master": "0.14-dev"
"dev-master": "0.15-dev"
}
}
}

0 comments on commit ad4bddb

Please sign in to comment.