Fix Github "released version" mismatch with actual release version

[bunny-therapist]

Every time there is a new release of arcade, I see something like this:

and then I go to install that new version of arcade, and it does not work. Then I remember that I always have to subtract one from the version. If it says that 3.0.0.dev42 is released, it means that 3.0.0.dev41 is released.

The same mismatch is also visible on the main repo page (bottom right):

This ticket is a request to make it so that the version that is announced and listed on Github matches the version that is actually available on PyPI.

Other python projects do not have this problem. For example, see

• pytest: https://pypi.org/project/pytest/#history latest version matches https://github.com/pytest-dev/pytest/releases/tag/8.3.4
• flake8: https://pypi.org/project/flake8/#history matches https://github.com/PyCQA/flake8/tags
• pyglet: https://pypi.org/project/pyglet/#history matches https://github.com/pyglet/pyglet/releases/tag/v2.1.0

[bunny-therapist]

I included the examples because I have raised this issue before on discord but I got the impression that this mismatch was seen as something normal and then it was never addressed. They may also give some inspiration for how to solve it.

[einarf]

We should fix this. It's confusing. It's ok to bump version in the toml but a tag should not be created until the that version is released because the tag is something you should be able to check out to obtain that version.

It's an automation bug. Scripts needs tweaking.

[DragonMoffon]

The explanation:
The bump-version workflow updates VERSION and collects all of the commits since the last release. It then makes this into a commit and turns it into a tag. This lets us automate releasing new arcade versions. Awesome!!
The deploy-to-pypi-prod workflow then checkouts with fetch-depth=1 which is the latest commit. We just made the release commit so it will be that yippee!! EXCEPT we are also checking out with fetch-tags=false which means we ignore tags even with fetch-depth>0. This means we don't checkout our latest bump version commit :(

The proof:
The last code changing commit of version 3.0.0-dev42 is gui: fix scrolling for small content(d71ea18) which add this condition into the experimental gui scroll area:

if scroll_range <= 0:
  # content is smaller than the scroll area, no need for a thumb
  return XYWH(0, 0, 0, 0)

If we check pypi's 3.0.0-dev41 we will see that this code is also in there!

if scroll_range <= 0:
  # content is smaller than the scroll area, no need for a thumb
  return XYWH(0, 0, 0, 0)

The solution:
update the workflow arguments to set 1fetch-tags1 to true and manually release 3.0.0-dev42 which will be functionally identical to 3.0.0-dev41 OR release 3.0.0-rc1 and banish dev42 to obscurity.