search

astro-pi / python-sense-hat

Source code for Sense HAT Python library
https://sense-hat.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
505 stars 253 forks source link

Mismatched versions across GitHub, PyPI, docs site(s) #140

Closed bbrewington closed 10 months ago

bbrewington commented 1 year ago

Seeing some version discrepancies across sites, so figured this table view would be the best way to collapse it all. I'm assuming everything needs to match the latest version in GitHub releases

Also, I'm new here and don't see a CI .yml file or maintenance instructions in a Wiki - so pardon my ignorance with this question: Would it make sense to set up automation so that when there is a new release in GH repo, it publishes updates to PyPI & readthedocs? And if that was automated, it might help ensure everything matches for future releases

Page sense-hat Version Issues
GitHub Repo astro-pi/python-sense-hat v2.5.1 (2022-11-21) 1. Releases has version 2.5.1 (link)
2. init.py has version 2.4.0 (link)
3. setup.py has version 2.4.0 (permalink)
PyPI (link) v2.4.0 (2022-08-09) 1. is behind GitHub release
sense-hat.readthedocs.io (link) v2.4.0 (2022-11-21) 1. is behind GitHub release
pythonhosted.org/sense-hat (link) v2.2.0 1. Now that readthedocs is live, this needs to be removed from this repo (link to GH search) --> addressed in PR #129
2. Needs to be updated in github.com/raspberrypi --> sense-hat
bsimmo commented 1 year ago

Have a look a #139, it says the others get bumped when RPF ask for it.

This may well be because AstroPiAstroPi use this and any major changes might alter the project at the time of year it is running.(ignoring any RPF Project documents that may also need a tweak)

SenseEmu may need a tweak too https://github.com/astro-pi/python-sense-emu (and Trinket?)

bbrewington commented 1 year ago

Got it. From here, I see two options to make sure that people in the future understand this... which one is preferable?

  1. Document that versions may be different - in the repo, PyPI, and readthedocs
  2. Set up automation so release is automated (and "release" means "go update all versions)

Or am I misunderstanding the issue linked above?

G3zz commented 11 months ago

Thank you for making the table. I have aligned the version numbers everywhere (and released a new version for the new Astro Pi year), and requested a new release be prepared by RP OS.

G3zz commented 10 months ago

The version numbers are now all aligned, so I will close this issue. Thanks!