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

Adding versioning through CI #33

Open
Poolitzer opened this issue Sep 20, 2021 · 2 comments
Open

Adding versioning through CI #33

Poolitzer opened this issue Sep 20, 2021 · 2 comments
Labels
enhancement New feature or request hacktoberfest

Comments

@Poolitzer
Copy link
Member

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/[email protected].

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 :)

@Poolitzer Poolitzer added bug 🐛 Something isn't working enhancement New feature or request hacktoberfest and removed bug 🐛 Something isn't working labels Sep 20, 2021
@Bibo-Joshi
Copy link
Member

Bibo-Joshi commented Sep 20, 2021

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. Improve tests & code quality #29 changes modules but doesn't really justify a version bump.

@Poolitzer
Copy link
Member Author

  • 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 Improve tests & code quality #29 changes modules but doesn't really justify a version bump.

jup agreed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request hacktoberfest
Projects
None yet
Development

No branches or pull requests

2 participants