8000 Releasing a new version · python-telegram-bot/python-telegram-bot Wiki · GitHub
[go: up one dir, main page]
Skip to content

Releasing a new version

Jump to bottom Edit New page
Bibo-Joshi edited this page Mar 15, 2025 · 38 revisions

Releasing a new version

This project adheres to the Semantic Versioning specification by Tom Preston-Werner.

The actual release (i.e. building the distributions and uploading to PyPI) are automated via GitHub actions. What currently needs to be done manually is updating the changelog and version files.

Process

  • Bump version:

    • telegram/_version.py
    • Replace all ocurrences of NEXT.VERSION by the correct version string in the docstrings
    • if the release includes a Bot API update, update README.rst
    • if the release drops a Python version, update README.rst and pyproject.tolm

  • Commit & create a PR

  • Make sure that the chango fragment is created correctly for an internal change. Run chango release --uid vXX.yy and commit the result.

  • If all checks pass, squash-merge with the commit message:

    Bump version to v<VERSION> (#<PR-Number>)

  • Trigger the workflow for releasing to PyPI (click "Run workflow" and select the master branch)

  • Approve the deployment request for PyPI

  • Wait for the GitHub action to finish uploding to PyPI and the GitHub releases page

  • Adjust the new release if necessary:

  • On Readthedocs dashboard check that latest, stable and vXX.YY are built correctly

  • Close milestones for this version.

  • Test in a clean virtualenv that pip install python-telegram-bot work with the new version.

  • If the doc-fixes branch got merged, create a new one.

  • Merge the dev-wiki into the production wiki

Public Announcements

Please use the following channels/groups to announce a new version release:

Channel posts should be a bit more verbose than the plain release notes. E.g. they can

  • list the (non-dev-team) authors, who contributed to the release, maybe even for each PR
  • have a short, informative description of new/changed features

Wiki of python-telegram-bot © Copyright 2015-2025 – Licensed by Creative Commons

Must read

  1. Introduction to the API
  2. Tutorial: Your first bot
  3. FAQ
  4. How to ask good questions
  5. How to write an MWE

Concepts & Important Elements

  1. Architecture Overview
  2. Builder Pattern for Application
  3. Types of Handlers
  4. Working with Files and Media
  5. Exceptions, Warnings and Logging
  6. Concurrency in PTB

Notable Features

  1. Advanced Filters
  2. Storing data
  3. Making your bot persistent
  4. Adding Defaults
  5. Job Queue
  6. Arbitrary callback_data
  7. Avoiding flood limits
  8. Webhooks
  9. Bot API Forward Compatiblity

Code Resources

  1. Frequently requested design patterns
  2. Code snippets
  3. Performance Optimizations
  4. Telegram Passport
  5. Bots built with PTB
  6. Automated Bot Tests

Examples explained

  1. InlineKeyboard Example

Networking

  1. Working Behind a Proxy
  2. Handling network errors

Other resources

  1. Where to host Telegram Bots
  2. How to host your bot
  3. Local API Server
  4. Type Checking with PTB
  5. Press
  6. Notes on GAE
  7. Related Projects
  8. Emoji

Transition Guides

Administration

Clone this wiki locally
0