From 9f68a1d8045b5cf545cdfc9d94752d3040391d1c Mon Sep 17 00:00:00 2001 From: norareidy Date: Wed, 7 May 2025 16:50:33 -0400 Subject: [PATCH 1/6] DOCSP-48100: Consolidate 1.x versions --- snooty.toml | 2 +- source/upgrade.txt | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/snooty.toml b/snooty.toml index a15ae3ae..754960c0 100644 --- a/snooty.toml +++ b/snooty.toml @@ -40,7 +40,7 @@ php-library = "MongoDB PHP Library" [constants] php-library = "MongoDB PHP Library" -version = "1.20" +version = "1.21" source-gh-branch = "v1.x" full-version = "{+version+}.0" extension-short = "PHP extension" diff --git a/source/upgrade.txt b/source/upgrade.txt index 2ea4cedf..e20d62a7 100644 --- a/source/upgrade.txt +++ b/source/upgrade.txt @@ -85,15 +85,15 @@ and upgrade versions. For more information on release changes, see the release notes and associated JIRA tickets for each release on `GitHub `__. -Version 1.20 Breaking Changes +Version 1.x Breaking Changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This library version introduces the following breaking changes: -- Drops support for {+mdb-server+} 3.6. +- Drops support for {+mdb-server+} 3.6 in {+php-library+} v1.20 -Version 1.19 and Earlier -~~~~~~~~~~~~~~~~~~~~~~~~ +.. tip:: Earlier Library Versions -For library versions 1.19 and earlier, see the release notes and associated -JIRA tickets for each release on `GitHub `__. + To view breaking changes for {+php-library+} versions 1.19 and earlier, see the + release notes and associated JIRA tickets for each release on `GitHub + `__. From 6f10dcb5ecfc3acf5027f920f9ab628d77e5e11e Mon Sep 17 00:00:00 2001 From: norareidy Date: Thu, 15 May 2025 11:01:39 -0400 Subject: [PATCH 2/6] edits --- snooty.toml | 1 + source/upgrade.txt | 32 ++++++++++++++++++++++++-------- 2 files changed, 25 insertions(+), 8 deletions(-) diff --git a/snooty.toml b/snooty.toml index 754960c0..de53fb1e 100644 --- a/snooty.toml +++ b/snooty.toml @@ -52,3 +52,4 @@ api = "https://www.mongodb.com/docs/php-library/current/reference" string-data-type = "``string``" bool-data-type = "``bool``" int-data-type = "``int``" +language = "PHP" \ No newline at end of file diff --git a/source/upgrade.txt b/source/upgrade.txt index e20d62a7..c684d4d2 100644 --- a/source/upgrade.txt +++ b/source/upgrade.txt @@ -29,15 +29,16 @@ How to Upgrade Before you upgrade, perform the following actions: -- Ensure the new {+library-short+} version is compatible with the {+mdb-server+} versions - your application connects to and the PHP version your - application compiles with. For version compatibility information, see the - :ref:`{+php-library+} Compatibility ` - page. - Address any breaking changes between the library version your application is using and your planned upgrade version in the :ref:`Breaking Changes ` section. +- Ensure the new {+library-short+} version is compatible with the {+mdb-server+} versions + your application connects to and the PHP version your + application compiles with. For version compatibility information, see the + :ref:`Compatibility Changes ` section and the + :ref:`{+php-library+} Compatibility ` page. + .. tip:: To ensure compatibility across {+mdb-server+} versions when @@ -85,10 +86,25 @@ and upgrade versions. For more information on release changes, see the release notes and associated JIRA tickets for each release on `GitHub `__. -Version 1.x Breaking Changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Version 1.0 Breaking Changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To view breaking changes for this major release, see the +:github:`release notes ` +on GitHub. + +.. _php-compat-changes: + +Compatibility Changes +--------------------- + +This section describes the {+mdb-server+} and {+language+} compatibility +changes introduced in {+php-library+} version releases. + +Version 1.x Compatibility Changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This library version introduces the following breaking changes: +This library version introduces the following compatibility changes: - Drops support for {+mdb-server+} 3.6 in {+php-library+} v1.20 From 5dd561c0d7b16e08b01a6346575fa27405624eb5 Mon Sep 17 00:00:00 2001 From: norareidy Date: Thu, 15 May 2025 11:06:19 -0400 Subject: [PATCH 3/6] stage From 27dee4e33bfc86f46a23db6106894c6165ae3bc4 Mon Sep 17 00:00:00 2001 From: norareidy Date: Thu, 15 May 2025 11:11:24 -0400 Subject: [PATCH 4/6] word --- source/upgrade.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/upgrade.txt b/source/upgrade.txt index c684d4d2..f2950959 100644 --- a/source/upgrade.txt +++ b/source/upgrade.txt @@ -110,6 +110,6 @@ This library version introduces the following compatibility changes: .. tip:: Earlier Library Versions - 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 release notes and associated JIRA tickets for each release on `GitHub `__. From 229690c9c933601ca2dc21a3c678e134ffeb6662 Mon Sep 17 00:00:00 2001 From: norareidy Date: Thu, 15 May 2025 13:13:19 -0400 Subject: [PATCH 5/6] stage From 21e6b13079b6a39e0fbb5f809f297634c70138fd Mon Sep 17 00:00:00 2001 From: norareidy Date: Thu, 15 May 2025 13:53:34 -0400 Subject: [PATCH 6/6] fix link --- source/upgrade.txt | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/source/upgrade.txt b/source/upgrade.txt index f2950959..a9171431 100644 --- a/source/upgrade.txt +++ b/source/upgrade.txt @@ -79,9 +79,10 @@ A breaking change is a change of a convention or a behavior starting in a specif version of the library. This type of change may prevent your application from working properly if not addressed before upgrading the library. -The breaking changes in this section are categorized by the library version that introduced -them. When upgrading library versions, address all the breaking changes between the current -and upgrade versions. +The breaking changes in this section are categorized by the library +version that introduced them. Only major library versions introduce +breaking changes. When upgrading versions, address all +the breaking changes between the current and upgrade versions. For more information on release changes, see the release notes and associated JIRA tickets for each release on `GitHub `__. @@ -90,7 +91,7 @@ Version 1.0 Breaking Changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ To view breaking changes for this major release, see the -:github:`release notes ` +:github:`release notes ` on GitHub. .. _php-compat-changes: