Prepare to release 0.18.0

CHANGELOG.md

@@ -4,6 +4,18 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 
 ## [Unreleased][unreleased]
 
+## [0.18.0] - 2018-09-18
+
+### Added
+
+ - Added `ConverterInterface` to `Converter` and `CommonMarkConverter` (#330)
+ - Added `ListItem::getListData()` method (#329)
+
+### Changed
+
+ - Links with `target="_blank"` will also get `rel="noopener noreferrer"` by default (#331)
+ - Implemented several performance optimizations (#324)
+
 ## [0.17.5] - 2018-03-29
 
 ### Fixed
@@ -645,7 +657,8 @@ An unused constant and static method were deprecated and will be removed in a fu
 ### Added
  - Initial commit (compatible with jgm/stmd:spec.txt @ 0275f34)
 
-[unreleased]: https://github.com/thephpleague/commonmark/compare/0.17.5...HEAD
+[unreleased]: https://github.com/thephpleague/commonmark/compare/0.18.0...HEAD
+[0.18.0]: https://github.com/thephpleague/commonmark/compare/0.17.5...0.18.0
 [0.17.5]: https://github.com/thephpleague/commonmark/compare/0.17.4...0.17.5
 [0.17.4]: https://github.com/thephpleague/commonmark/compare/0.17.3...0.17.4
 [0.17.3]: https://github.com/thephpleague/commonmark/compare/0.17.2...0.17.3

README.md

@@ -154,17 +154,17 @@ $ ./tests/benchmark/benchmark.php
 
 ## Versioning
 
-[SemVer](http://semver.org/) will be followed closely.  0.x.0 versions will introduce breaking changes to the codebase, so be careful which version constraints you use. **It's highly recommended that you use [Composer's caret operator](https://getcomposer.org/doc/articles/versions.md#caret) to ensure compatibility**; for example: `^0.16`.  This is equivalent to `>=0.16.0 <0.17.0`.
+[SemVer](http://semver.org/) will be followed closely.  0.x.0 versions will introduce breaking changes to the codebase, so be careful which version constraints you use. **It's highly recommended that you use [Composer's caret operator](https://getcomposer.org/doc/articles/versions.md#caret) to ensure compatibility**; for example: `^0.18`.  This is equivalent to `>=0.18.0 <0.19.0`.
 
 0.x.y releases should not introduce breaking changes to the codebase; however, they might change the resulting AST or HTML output of parsed Markdown (due to bug fixes, minor spec changes, etc.)  As a result, you might get slightly different HTML, but any custom code built onto this library will still function correctly.
 
-If you're only using the `CommonMarkConverter` class to convert Markdown (no other class references, custom parsers, etc.), then it should be safe to use a broader constraint like `~0.16`, `>0.16`, etc.  I personally promise to never break this specific class in any future 0.x release.
+If you're only using the `CommonMarkConverter` class or `ConverterInterface` to convert Markdown (no other class references, custom parsers, etc.), then it should be safe to use a broader constraint like `~0.18`, `>0.18`, etc.  I personally promise to never break this specific class in any future 0.x release.
 
 ## Stability
 
 While this package does work well, the underlying code should not be considered "stable" yet.  The original spec and JS parser may undergo changes in the near future which will result in corresponding changes to this code.  Any methods tagged with `@api` are not expected to change, but other methods/classes might.
 
-Major release 1.0.0 will be reserved for when both CommonMark and this project are considered stable (see [outstanding CommonMark spec issues](http://talk.commonmark.org/t/issues-to-resolve-before-1-0-release/1287)).  0.x.y will be used until that happens.
+Major release 1.0.0 will be reserved for when either the CommonMark spec or this project are considered stable (see [outstanding CommonMark spec issues](http://talk.commonmark.org/t/issues-to-resolve-before-1-0-release/1287)).  0.x.y will be used until that happens.
 
 ## Contributing
 

UPGRADE.md

@@ -1,5 +1,9 @@
 # Upgrade Instructions
 
+## 0.18.0
+
+No breaking changes were introduced, but we did add a new interface: `ConverterInface`. Consider depending on this interface in your code instead of the concrete implementation. (See #330)
+
 ## 0.17.0
 
 ## Minimum PHP version

composer.json

@@ -60,7 +60,7 @@
     "bin": ["bin/commonmark"],
     "extra": {
         "branch-alias": {
-            "dev-master": "0.18-dev"
+            "dev-master": "0.19-dev"
         }
     }
 }

src/CommonMarkConverter.php

@@ -24,7 +24,7 @@ class CommonMarkConverter extends Converter
      *
      * This might be a typical `x.y.z` version, or `x.y-dev`.
      */
-    const VERSION = '0.18-dev';
+    const VERSION = '0.19-dev';
 
     /**
      * Create a new commonmark converter instance.