DOCSP-48100: Consolidate minor versions #240
Conversation
✅ Deploy Preview for docs-php-library ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
source/upgrade.txt
Outdated
| Version 2.0 Breaking Changes | ||
| Version 2.x Breaking Changes |
There was a problem hiding this comment.
IMO, it makes sense to call these out as breaking changes in 2.0 - people will understand that these apply to future 2.x versions as well. This helps clarify that we don't make breaking changes in minor versions.
There was a problem hiding this comment.
Fixed! I also added a sentence in the "Breaking Changes" introduction noting that only major version releases have breaking changes
source/upgrade.txt
Outdated
| @@ -113,15 +113,15 @@ This library version introduces the following breaking changes: | |||
| methods, you can register a :php:`CommandSubscriber | |||
| <mongodb-driver-monitoring-commandsubscriber>` in your application. | |||
|
|
|||
| Version 1.20 Breaking Changes | |||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |||
| Version 1.x Breaking Changes | |||
There was a problem hiding this comment.
| Version 1.x Breaking Changes | |
| Version 1.x Compatibility Changes |
We don't consider bumping dependencies such as minimum PHP or server versions as "breaking changes", as that would require us to only do these in a major version. The rationale is that for PHP versions, the compatibility is checked by composer, so users on a version of PHP that is no longer supported won't be upgraded to the newer driver version and thus don't encounter a breaking change. Since the server version drops are so far behind (one year after it's marked EOL by the server team), the number of people affected is fairly low. For example, we're only now dropping support for MongoDB 4.0.
There was a problem hiding this comment.
I see; I moved the compatibility changes to its own section to separate it from the breaking changes
source/upgrade.txt
Outdated
|
|
||
| For library versions 1.19 and earlier, see the release notes and associated | ||
| JIRA tickets for each release on `GitHub <https://github.com/mongodb/mongo-php-library/releases>`__. | ||
| To view breaking changes for {+php-library+} versions 1.19 and earlier, see the |
There was a problem hiding this comment.
| To view breaking changes for {+php-library+} versions 1.19 and earlier, see the | |
| To view compatibility changes for {+php-library+} versions 1.19 and earlier, see the |
* DOCSP-44581: v2 release (#234) * DOCSP-44581: v2 release * small fix * Add missing meta descriptions (#235) * Add missing meta descriptions * Apply suggestions from code review --------- Co-authored-by: Rachel Mackintosh <[email protected]> * DOCSP-48761: docker note (#237) * DOCSP-48100: Consolidate minor versions (#240) * DOCSP-48100: Consolidate minor versions * edits * remove old redirects * AB feedback * edit * DOCSP-48718-update-credentials (#247) * update username and password * misspelling * redirects * pre-standardization redirects * upgrade composer package vs * DOCSP-49150: bulkWrite docs + api (#250) * DOCSP-49150: bulkWrite docs + api * first pass fixes * JT PR fixes 1 * upgrade composer package vs * JT PR fixes 2 * small fix * JT PR fixes 3 * remove reference to writeconcern option * add return values sections * object -> instance * NR PR fixes 1 * returns -> throws * DOCSP-50022: remove eol server version mentions (#253) * DOCSP-50022: remove eol server version mentions * consolidate compat table rows * DOCSP-50155 - EOL MongoDB 4.0 (#252) * eol v4.0 * update compat * DOCSP-50294: v2.1 release (#255) --------- Co-authored-by: Nick Larew <[email protected]> Co-authored-by: Rachel Mackintosh <[email protected]> Co-authored-by: Nora Reidy <[email protected]> Co-authored-by: shuangela <[email protected]> Co-authored-by: Mike Woofter <[email protected]>
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-48100
Staging Links
Self-Review Checklist