python-telegram-bot / python-telegram-bot/ptbcontrib

Adding versioning through CI

Open
#33 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement hacktoberfest
Dominant language
Python
Stars
118
Forks
47
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked release-it GitHub Actions documentation and inspecting the repository's existing versioning and CI configuration. Determine how module additions and updates should map to major and minor versions, and define the CI-driven release process so that versioned Git installation works as described.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd, release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.