python-telegram-bot/ptbcontrib

Adding versioning through CI

Poolitzer opened this issue · 2 comments

Poolitzer commented

This idea came up in a discussion group, https://t.me/c/1101839433/8235. One can increase the major version every time a new module is added, and a minor increase if a module gets updated.

The benefit would be to enable installing ptbcontrib with pip install git+https://github.com/python-telegram-bot/ptbcontrib@v1.3.

This should be possible, according to this document: https://github.com/release-it/release-it/blob/master/docs/ci.md#github-actions

Great issue for someone foreign to the project trying to make a small change :)

Bibo-Joshi commented

I like the idea! But have a few questions & comments:

  • How do we determine the version number? manually or should the CI do that on it's own?
  • making a release would "only" serve better visibility on repo page. for installing via @v1.3 we also need a tag
  • There also seem to be some native GH-actions thingies for making releases: https://github.com/actions/create-release#github-action---releases-api
  • Removing a contribution should probably also lead to a major version bump?
  • install instructions in the readme should be updated in a PR that tackles this
  • We should add an option to skip the version bump, e.g. by writing something like "CI: skip-bump" into the commit description. E.g. #29 changes modules but doesn't really justify a version bump.
Poolitzer commented
  • How do we determine the version number? manually or should the CI do that on it's own?

I would like having it do that on its own

  • making a release would "only" serve better visibility on repo page. for installing via @v1.3 we also need a tag

uh. sure, shouldn't be a problem either with CI

cool :D

  • Removing a contribution should probably also lead to a major version bump?

yeah I would do that

  • install instructions in the readme should be updated in a PR that tackles this
  • We should add an option to skip the version bump, e.g. by writing something like "CI: skip-bump" into the commit description. E.g.
  • Improve tests #29 changes modules but doesn't really justify a version bump.

jup agreed