Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revert v2 nested groups and release 3.0 #1071

Merged
merged 4 commits into from
Apr 17, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 12 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# jms/serializer

| [Master][Master] | [1.x][1.x] |
|:----------------:|:----------:|
| [![Build status][Master image]][Master] | [![Build status][1.x image]][1.x] |
| [![Coverage Status][Master coverage image]][Master coverage] | [![Coverage Status][1.x coverage image]][1.x coverage] |

[![Build status][Master image]][Master]
[![Coverage Status][Master coverage image]][Master coverage]

![alt text](doc/logo-small.png)

Expand All @@ -28,17 +27,16 @@ Learn more about the serializer in its [documentation](http://jmsyst.com/libs/se

## Notes

You are browsing the code for the 2.x version, if you are interested in the 1.x version,
check the [1.x][1.x] branch.
You are browsing the code for the 3.x version, if you are interested in the 1.x or 2.x version,
check the [1.x][1.x] and [2.x][2.x] branches.

Differences between the 1.x and 2.x can be found in the [CHANGELOG][CHANGELOG].
Upgrading from 1.x to 2.x should be almost transparent for most of the userland code, in the
case you have heavily used internal-api or you are relaying on some of the removed features,
the [UPGRADING][UPGRADING] document is a short guide on how to upgrade.
Instructions on how to upgrade available in the [UPGRADING][UPGRADING] document.

Pull requests for new features are accepted only on the master branch.
Bug fixes are accepted for both master and 1.x branches.
Bug fixes sent on the 1.x branch, will be ported to the master branch when possible.
- `3.x` is the active and supported version (`master` branch).
- `2.x` is not supported anymore (`2.x` branch).
- `1.x` is in maintenance mode, there will be no active development but PRs are accepted (`1.x` branch).

Bug fixes sent on the 1.x branch, will be ported to the master branch when possible.

[CHANGELOG]: https://github.com/schmittjoh/serializer/blob/master/CHANGELOG.md
[UPGRADING]: https://github.com/schmittjoh/serializer/blob/master/UPGRADING.md
Expand All @@ -48,8 +46,5 @@ Bug fixes sent on the 1.x branch, will be ported to the master branch when possi
[Master coverage image]: https://img.shields.io/scrutinizer/coverage/g/schmittjoh/serializer/master.svg?style=flat-square
[Master coverage]: https://scrutinizer-ci.com/g/schmittjoh/serializer/?branch=master

[1.x image]: https://img.shields.io/travis/schmittjoh/serializer/1.x.svg?style=flat-square
[1.x]: https://github.com/schmittjoh/serializer/tree/1.x
[1.x coverage image]: https://img.shields.io/scrutinizer/coverage/g/schmittjoh/serializer/1.x.svg?style=flat-square
[1.x coverage]: https://scrutinizer-ci.com/g/schmittjoh/serializer/?branch=1.x

[2.x]: https://github.com/schmittjoh/serializer/tree/2.x
24 changes: 21 additions & 3 deletions UPGRADING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,26 @@
From 1.12.0 to 2.0.0
From 2.x to 3.0.0
=================

Upgrading from 2.x to 3.x should require almost no effort.

The only change is the revert of "deeper branch group exclusion strategy" introduced in 2.0.0 and now reverted as it
was in 1.x. If you are not using this feature, then upgrading requires no changes at all.

The deprecations introduced in 2.x are still present in 3.0.0, said feature are most likley to be removed in an next major.

From 1.x to 3.0.0
=================

Please follow the upgrade **"From 1.13.0 to 2.0.0"**, skipping the section:

> "deeper branch group exclusion strategy" has a different behaviour, the latest group is used instead of falling back to "Default"

The deprecations introduced in 2.x are still present in 3.0.0, said feature are most likley to be removed in an next major.

From 1.13.0 to 2.0.0
====================

Upgrading from 1.x to 2.x should be almost transparent for most of the userland code,
in case you have heavily used internal-api here are the most important the changes:
If you are on version `1.x`, is suggested to migrate directly to `3.0.0` (since `2.x` is not maintained anymore).

**Main changes**

Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
},
"extra": {
"branch-alias": {
"dev-master": "2.3-dev"
"dev-master": "3.0-dev"
}
}
}
Loading