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

🔖 (release): v4.0.0rc1 #480

Merged
merged 4 commits into from
Feb 28, 2024
Merged

🔖 (release): v4.0.0rc1 #480

merged 4 commits into from
Feb 28, 2024

Conversation

schlich
Copy link
Contributor

@schlich schlich commented Feb 21, 2024

No description provided.

@dkirkham
Copy link
Contributor

Hi @schlich, thanks for merging #472, but it wasn't quite ready... as well as the docs, there are some packaging and testing changes. Many are in my local repo, so I'll now create separate PRs for those.

There are also some breaking changes, impacting anyone who has customised the admin, which would suggest we should be going for v4.0 rather than v3.2.0.

@schlich
Copy link
Contributor Author

schlich commented Feb 21, 2024

Thanks for the update @dkirkham -- the merge doesn't trigger a release or anything, and as far as I'm concerned as a maintainer if it passes CI it is safe to merge to main -- if you think the merge is in a broken state then let's make sure we capture those failure states in tests.

Thanks for the major release warning -- I had questions about whether this might be a minor or major release. Can you point me to some code related to the breaking change? Let's make sure we have a migration process documented.

Let me know if there's anything I can do to help with the packaging/testing changes you mention (maybe this resolves my comments above).

@MrCordeiro
Copy link
Contributor

On that note, @schlich please allow at least one day between opening a PR and merging it so that it gets the chance to be reviewed by other people.

This is what we've been following in this project for other PRs.

@dkirkham
Copy link
Contributor

@schlich, see the comment at #472 (comment). I have mostly documented this breaking change in the release notes, which I haven’t had a chance to commit - a bit more checking to do first.

@@ -2,7 +2,7 @@

# major.minor.patch.release.number
# release must be one of alpha, beta, rc, or final
VERSION = (3, 1, 9, "final", 0)
VERSION = (3, 2, 0, "rc", 0)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
VERSION = (3, 2, 0, "rc", 0)
VERSION = (4, 0, 0, "rc", 0)

I think we can call this v4.0... By the way, don't forget to update the CHANGELOG.md and the documentation's release notes in this PR 😉

https://wagtailmenus.readthedocs.io/en/stable/releases/index.html

Copy link
Contributor

Choose a reason for hiding this comment

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

May I suggest the following CHANGELOG entry for my recent contribution:

* Fix [#459](https://github.com/jazzband/wagtailmenus/issues/459) by adding support for Wagtail 5.2, Wagtail 6.0 and Python 3.12.

Copy link
Contributor

Choose a reason for hiding this comment

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

I would just go with "Added support for x, y, z" and then add another entry saying

Fix [#459](https://github.com/jazzband/wagtailmenus/issues/459) by migrating to wagtail.snippets. Removed `wagtail_modeladmin` support.

That way it becomes more explicit.

@MrCordeiro
Copy link
Contributor

@dkirkham, I think we are close to a release, right? :D

@dkirkham
Copy link
Contributor

@MrCordeiro and @schlich, I'm happy with my changes, now that they are merged. I have retested with a full set of tests using tox, and then within my own project by installing the master branch with pip. All good.

As far as I can see, this PR needs to have:

  • the version updated to 4.0rc (as per your suggestion)
  • CHANGELOG updated with this change (changenote as above) and anything else in the release
  • docs/sources/releases/4.0.rst with any other documentation changes also in this release

May I leave that to you or the other contributors?

@schlich
Copy link
Contributor Author

schlich commented Feb 27, 2024

Yep i can take care of that this evening, rock on

@schlich schlich changed the title 🔖 (release): v3.2.0rc0 🔖 (release): v4.0.0rc1 Feb 28, 2024
@schlich schlich merged commit a729ddb into master Feb 28, 2024
13 checks passed
@schlich schlich deleted the release branch February 28, 2024 07:26
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.

3 participants