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

Update upgrading guide #2716

Merged
merged 7 commits into from
Jan 4, 2025
Merged

Update upgrading guide #2716

merged 7 commits into from
Jan 4, 2025

Conversation

sloria
Copy link
Member

@sloria sloria commented Jan 3, 2025

No description provided.

@sloria sloria added this to the 4.0 milestone Jan 3, 2025
@sloria sloria marked this pull request as ready for review January 3, 2025 21:33
@sloria
Copy link
Member Author

sloria commented Jan 3, 2025

@lafrech i think this PR and #2707 are the last ones to merge before 4.0 is release-ready 🙌

we should also ensure that the other marshmallow libs are compatible with this 4.0 before we release

@sloria sloria assigned lafrech and unassigned lafrech Jan 3, 2025
@sloria sloria requested a review from lafrech January 3, 2025 21:36
@sloria
Copy link
Member Author

sloria commented Jan 3, 2025

we already test the other libs against the marshmallow dev branch: https://github.com/marshmallow-code/apispec/blob/6583194325b5cd2033537d34d58cbf6ce2b99d2b/.github/workflows/build-release.yml#L30-L35

so i think the correct order of operations is

  1. merge this PR and Use a context variable to pass Schema context #2707
  2. create 3.x-line branch off of dev. enable docs builds in readthedocs
  3. merge 4.0 branch into dev and remove 4.0
  4. ensure libraries pass against marshmallowdev. make any necessary releases.
  5. release 4.0

@sloria
Copy link
Member Author

sloria commented Jan 4, 2025

@lafrech @deckar01 how long should we support 3.x for? should we continue merging features into 3.x, and if so, for how long? how long should we continue with bugfixes, i.e. when should be its EOL?

@lafrech
Copy link
Member

lafrech commented Jan 4, 2025

Compared to marshmallow 3.0, the migration should be very smooth for the user. But libs using marshmallow may take a little time to migrate.

I propose to feature freeze 3.x right now and merge bugfixes for a few months.

Copy link
Member

@lafrech lafrech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see anything in the changelog that should appear in the upgrading guide but does not.

@sloria sloria merged commit 621c188 into 4.0 Jan 4, 2025
9 checks passed
@sloria sloria deleted the upgrading-guide branch January 4, 2025 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants