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

CHANGELOG file #13279

Closed
tony opened this issue Jul 28, 2022 · 4 comments
Closed

CHANGELOG file #13279

tony opened this issue Jul 28, 2022 · 4 comments
Labels

Comments

@tony
Copy link

tony commented Jul 28, 2022

I've seen an earlier issue on this closed (#2859) as well as a recent issue bringing up changelogs (#12210)!

Feature

Single file changelog, with changes release manager deems most significant weighted to the top

Pitch

Problem
I feel it's really difficult a user to track changes the maintainer deems useful. Users are left to git log or taking several clicks to find release notes.

A normal user is going to end up being a few releases behind, and they may be overwhelmed by how much effort it takes to see what changed

What I think is most helpful
I personally find git logs interesting to read, however, I imagine mypy may be far along enough its worth keeping a changelog.

When a maintainer is cutting the release, they can go back and take a few minutes to weigh what's happened since last release and curate highlights of the changelog.

Why I think a single, curated changelog is best

  • Can be linked to via PyPI, one page
  • No extra clicks or pagination
  • Search via control-f / command-f
  • Scroll
  • Can be linked to git tags (in future release, if a changelog is added)

Other references

@tony tony added the feature label Jul 28, 2022
@tony
Copy link
Author

tony commented Nov 24, 2022

It would be a dream to have this (still!)

br3ndonland added a commit to br3ndonland/fastenv that referenced this issue Feb 26, 2023
This commit will update to mypy 1. In the past, releases were managed by
Dropbox (python/mypy#12210), and were done at infrequent intervals. They
plan to release more regularly in the future.

Mypy does not keep a changelog, but did provide a 1.0 release blog post:
https://mypy-lang.blogspot.com/2023/02/mypy-10-released.html

A changelog has been requested (python/mypy#2859, python/mypy#13279),
but has been dismissed because "you can view the git history easily."

The new release versioning scheme is in the format `major.minor.patch`,
but is not SemVer-compliant, as explained in their blog post and wiki.
https://github.com/python/mypy/wiki/Release-Process

The update to mypy 1 was postponed until bug fixes were available in the
1.0.1 patch release (python/mypy#13685).
br3ndonland added a commit to br3ndonland/inboard that referenced this issue Feb 26, 2023
This commit will update to mypy 1. In the past, releases were managed by
Dropbox (python/mypy#12210), and were done at infrequent intervals. They
plan to release more regularly in the future.

Mypy does not keep a changelog, but did provide a 1.0 release blog post:
https://mypy-lang.blogspot.com/2023/02/mypy-10-released.html

A changelog has been requested (python/mypy#2859, python/mypy#13279),
but has been dismissed because "you can view the git history easily."

The new release versioning scheme is in the format `major.minor.patch`,
but is not SemVer-compliant, as explained in their blog post and wiki.
https://github.com/python/mypy/wiki/Release-Process

The update to mypy 1 was postponed until bug fixes were available in the
1.0.1 patch release (python/mypy#13685).
@jessestricker
Copy link

for anyone, who like me ended up here in search of a changelog file:
there is none, but the release notes are available on their blog, which you can find here:
https://mypy-lang.blogspot.com/

i'm in favor of a proper CHANGELOG file, though

@hauntsaninja
Copy link
Collaborator

We're going to try to keep release notes inside the repo, see #16280
These are just the equivalent of the blogspot posts, for a full revision history, git log will always be authoritative

@tony
Copy link
Author

tony commented Oct 18, 2023

Thanks @hauntsaninja!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants