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

Prepare for release 3.7.0 #1350

Merged
merged 2 commits into from
May 29, 2024
Merged

Prepare for release 3.7.0 #1350

merged 2 commits into from
May 29, 2024

Conversation

ddabble
Copy link
Member

@ddabble ddabble commented May 29, 2024

Description

Added a 3.7.0 version section to CHANGES.rst, and moved the PyPI readme comments (695b17f).

Also replaced the PyPI readme comments in CHANGES.rst with a regex in pyproject.toml, to avoid having to move the comments every time we're preparing a new release (1fe70ab).

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have run the pre-commit run command to format and lint.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have added my name and/or github handle to AUTHORS.rst
  • I have added my change to CHANGES.rst
  • All new and existing tests passed.

This avoids having to move the comments in `CHANGES.rst` *every* time
we're preparing a new release.
@ddabble ddabble added the release Pull requests that prepare for a new release label May 29, 2024
@ddabble
Copy link
Member Author

ddabble commented May 29, 2024

@tim-schilling Any thoughts on replacing the PyPI readme comments with a somewhat complex regex (in 1fe70ab)? 🙂

@tim-schilling
Copy link
Contributor

somewhat complex regex

Somewhat eh? 😅

I think I'm good with it. If it doesn't work, it's a small problem and doesn't impact the library as a whole. I say to that to mean the risk is fairly low.

@ddabble
Copy link
Member Author

ddabble commented May 29, 2024

Somewhat eh? 😅

Hahah, I've seen too many regexes horrifyingly more complex than this one, so it's sometimes challenging to judge the complexity when I know those exist 😅

I think I'm good with it. If it doesn't work, it's a small problem and doesn't impact the library as a whole. I say to that to mean the risk is fairly low.

I agree :) Worst-case, the PyPI readme will contain parts of the Unreleased section, or the changelog won't be included at all - both of which I think are acceptable, since the unaltered changelog is present in both the docs and on GitHub (which are also linked to from PyPI).

@ddabble ddabble merged commit 2a2bec9 into master May 29, 2024
32 checks passed
@ddabble ddabble deleted the release-3.7.0 branch May 29, 2024 19:07
@ddabble
Copy link
Member Author

ddabble commented May 29, 2024

@treyhunner Would you mind publishing the newest version to PyPI, again? :)

@treyhunner
Copy link
Member

@treyhunner Would you mind publishing the newest version to PyPI, again? :)

Published 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release Pull requests that prepare for a new release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants