Skip to content
Permalink
Browse files

Prepare to release 1.0.0-beta2

  • Loading branch information...
colinodell committed May 27, 2019
1 parent d168ab5 commit 33e779e0b93c5ece071de0e42122b66f6a7514e9
Showing with 20 additions and 4 deletions.
  1. +4 −1 CHANGELOG.md
  2. +5 −1 UPGRADE.md
  3. +11 −2 docs/1.0/upgrading.md
@@ -4,6 +4,8 @@ Updates should follow the [Keep a CHANGELOG](https://keepachangelog.com/) princi

## [Unreleased][unreleased]

## [1.0.0-beta2] - 2019-05-27

### Changed

- `DelimiterProcessorInterface::process()` will accept any type of `AbstractStringContainer` now, not just `Text` nodes
@@ -870,7 +872,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/1.0.0-beta1...HEAD
[unreleased]: https://github.com/thephpleague/commonmark/compare/1.0.0-beta2...HEAD
[1.0.0-beta2]: https://github.com/thephpleague/commonmark/compare/1.0.0-beta1...1.0.0-beta2
[1.0.0-beta1]: https://github.com/thephpleague/commonmark/compare/0.19.2...1.0.0-beta1
[0.19.2]: https://github.com/thephpleague/commonmark/compare/0.19.1...0.19.2
[0.19.1]: https://github.com/thephpleague/commonmark/compare/0.19.0...0.19.1
@@ -2,12 +2,16 @@

**Note:** This file has been deprecated. Future upgrade instructions can be found on our website: <https://commonmark.thephpleague.com/releases>

## UNRELEASED
## 1.0.0-beta2

### Delimiter Processing

We've standardized the new delimiter processing to work with `AbstractStringContainer` nodes. Previously in 1.0.0-beta1, some parts (incorrectly) accepted any type of `Node`, while others forced you to use `Text` elements instead.

### Previous Deprecations Removed

All previously-deprecated code has been removed. If you've been following this upgrade guide with each release then you shouldn't have any of that code.

## 1.0.0-beta1

### Text Encoding
@@ -6,13 +6,22 @@ redirect_from: /0.20/upgrading/

# Upgrading from 0.19 to 1.0

### Text Encoding
## Previous Deprecations Removed

All previously-deprecated code has been removed. This includes:

- The `safe` option (use `html_input` and `allow_unsafe_links` options instead)
- All deprecated `RegexHelper` constants
- `DocParser::getEnvironment()` (you should obtain it some other way)
- `AbstractInlineContainer` (use `AbstractInline` instead and make `isContainer()` return `true`)

## Text Encoding

This library used to claim it supported ISO-8859-1 encoding but that never truly worked - everything assumed the text was encoded as UTF-8 or ASCII. We've therefore dropped support for ISO-8859-1 and any other unexpected encodings. If you were using some other encoding, you'll now need to convert your Markdown to UTF-8 prior to running it through this library.

Additionally, all public `getEncoding()` or `setEncoding()` methods have been removed, so assume that you're working with UTF-8.

### Inline Processors
## Inline Processors

The "inline processor" functionality has been removed and replaced with a proper "delimiter processor" feature geared specifically towards dealing with delimiters (which is what the previous implementation tried to do - poorly).

0 comments on commit 33e779e

Please sign in to comment.
You can’t perform that action at this time.