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 version number shown on GitHub is not latest release, leading to confusion #72

Open
mhucka opened this issue Jan 1, 2025 · 5 comments

Comments

@mhucka
Copy link

mhucka commented Jan 1, 2025

restview is excellent! One thing that confused me, however, is that on GitHub the latest version on the releases page is 2.0.4, which is actually not the latest version that one gets from pip install restview.

Given that PyPI seems to be the location where releases are actually put, perhaps it would be best to simply remove the releases from GitHub. Alternatively, it might help to have a note somewhere to explain that people should ignore what they see on the releases page because it doesn't reflect the real latest release.

@stevepiercy
Copy link

@mgedmin would you please cut all unreleased releases on GitHub? GitHub can generate release notes from tags.

@mgedmin
Copy link
Owner

mgedmin commented Jan 2, 2025

Apologies, I keep forgetting to update GitHub releases when I use my release automation via make release. I'll update the Makefile to print a reminder.

(I'm used to considering https://pypi.org/project/restview/#history as the canonical place that lists all releases.)

mgedmin added a commit that referenced this issue Jan 2, 2025
@mgedmin
Copy link
Owner

mgedmin commented Jan 2, 2025

The annoying part about adding GitHub release notes after the fact is that GitHub then decides the release was made today. This makes me reluctant to add missing GitHub releases for older tags.

Is there a way around this?

@stevepiercy
Copy link

Is there a way around this?

Not that I could find. https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases

@mhucka
Copy link
Author

mhucka commented Jan 2, 2025

I haven't tried it myself, but this sounds like a method to do that:

https://gist.github.com/frederikheld/191844766e82f669da26dac26e23ef8e

There's also this discussion on Stack Overflow: https://stackoverflow.com/q/21738647/28972686 – in particular the answer https://stackoverflow.com/a/76784008/28972686 seems to be a solution, if I'm reading it correctly.

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

No branches or pull requests

3 participants